approvals

Approval service handles the approval API to approve or reject pipeline executions

List approvals

List all the approvals

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

Org is the organisation identifier.

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

Project is the project identifier.

Example: m
query Parameters
limit
integer <int64> [ 1 .. 1000 ]
Default: 30

Limit is the number of records to return for a page.

Example: limit=30
page
integer <int64> >= 1
Default: 1

Page is the page number to return relative to the page 'limit'.

Example: page=1
workspace
string

Workspace identifier

Example: workspace=Cum quisquam praesentium eveniet explicabo eos laudantium.
pipeline_execution_id
string

Pipeline identifier

Example: pipeline_execution_id=Odio similique dolor eius ad nesciunt eos.
pipeline_stage_id
string

Pipeline stage identifier

Example: pipeline_stage_id=Laborum mollitia est modi quo praesentium nisi.
status_type
string

Status of the approval step

Enum: "approved" "rejected" "pending"
Example: status_type=rejected
header Parameters
Harness-Account
required
string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: nsn
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}/approvals
Request samples
Response samples
application/json
[
  • {
    },
  • {
    }
]

Create approval

Create an approval resource

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

Org is the organisation identifier.

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

Project is the project identifier.

Example: oo4
header Parameters
Harness-Account
required
string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: bd
Request Body schema: application/json
required
pipeline_execution_id
required
string

The unique identifier for the associated pipeline execution

pipeline_stage_id
required
string

The unique identifier for the associated pipeline execution stage

status
string
Default: "pending"

Status of the approval resource

Enum: "pending" "approved" "rejected"
workspace_id
required
string

The unique identifier for the workspace_id

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.

post/iacm/api/orgs/{org}/projects/{project}/approvals
Request samples
application/json
{
  • "pipeline_execution_id": "Voluptatum provident voluptas fugiat.",
  • "pipeline_stage_id": "Cumque est sunt est quia.",
  • "status": "rejected",
  • "workspace_id": "Porro ipsa odit corrupti."
}
Response samples
application/json
{
  • "id": "Atque dolor corrupti quae debitis cum voluptatem."
}

Show approval

Retrieve a single approval

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

Org is the organisation identifier.

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

Project is the project identifier.

Example: tix
id
required
string <uuid>
Example: 5a00dad9-54e4-4481-8ff8-44fd21a38343
header Parameters
Harness-Account
required
string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: nl
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}/approvals/{id}
Request samples
Response samples
application/json
{
  • "actioned_by": "John Doe",
  • "created": 3650184525441088000,
  • "status": "Id repellat est beatae.",
  • "updated": 8763687990281301000
}

Update approval

Update a single approval

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

Org is the organisation identifier.

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

Project is the project identifier.

Example: fcx
id
required
string <uuid>
Example: a2349bdd-b9de-4a26-aba1-ede67f10075c
header Parameters
Harness-Account
required
string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: t6
Request Body schema: application/json
required
actioned_by
string

User that approved/rejected the step

status
required
string
Default: "pending"

Status update to be performed upon the Approval step

Enum: "approved" "rejected" "pending"
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}/approvals/{id}
Request samples
application/json
{
  • "actioned_by": "John Doe",
  • "status": "approved"
}