settings

Settings service handles all API endpoints related to configuration settings

delete-default-pipeline settings

Delete the association between a default pipeline and a provisioner operation

Securityx-api-key
Request
path Parameters
org
required
string
Example: Adipisci qui a ex tenetur quisquam omnis.
project
required
string
Example: Esse excepturi placeat doloribus aspernatur enim.
header Parameters
Harness-Account
required
string
Example: Accusantium non voluptatem.
Request Body schema: application/json
required
operation
required
string

The default pipeline is associated with this operation

provisioner
required
string

The default pipeline is associated with this provisioner

Enum: "terraform" "opentofu"
workspace
string
Default: ""

The default pipeline is associated with this workspace if specified

Responses
200

OK response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

delete/iacm/api/orgs/{org}/projects/{project}/settings/default-pipelines
Request samples
application/json
{
  • "operation": "plan",
  • "provisioner": "opentofu",
  • "workspace": "plan"
}

list-default-pipelines settings

List all associations between provisioner operations and default pipelines

Securityx-api-key
Request
path Parameters
org
required
string [ 1 .. 128 ] characters

Org is the organisation identifier.

Example: iy3
project
required
string [ 1 .. 128 ] characters

Project is the project identifier.

Example: 2
query Parameters
workspace
string
Default: ""

Workspace identifier

Example: workspace=workspace123
header Parameters
Harness-Account
required
string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: gmc
Responses
200

OK response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

get/iacm/api/orgs/{org}/projects/{project}/settings/default-pipelines
Request samples
Response samples
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

upsert-default-pipeline settings

Associate a default pipeline with a provisioner operation

Securityx-api-key
Request
path Parameters
org
required
string
Example: Molestias consequuntur aut culpa sit sequi repudiandae.
project
required
string
Example: Minus aut unde dolorem commodi exercitationem.
header Parameters
Harness-Account
required
string
Example: Quos ratione ipsam est qui quidem.
Request Body schema: application/json
required
operation
required
string

The default pipeline is associated with this operation

pipeline
required
string

The default pipeline associated with the provisioner operation

provisioner
required
string

The default pipeline is associated with this provisioner

Enum: "terraform" "opentofu"
updated
required
integer <int64>

Time the default pipeline was last updated

workspace
string
Default: ""

The default pipeline is associated with this workspace if specified

Responses
200

OK response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

put/iacm/api/orgs/{org}/projects/{project}/settings/default-pipelines
Request samples
application/json
{
  • "operation": "plan",
  • "pipeline": "testpipeline",
  • "provisioner": "opentofu",
  • "updated": 1636669297674,
  • "workspace": "plan"
}