approvals

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

list-approvals approvals

List all the approvals

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

Org is the organisation identifier.

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

Project is the project identifier.

Example: jn
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=Aut aut dignissimos.
pipeline_execution_id
string

Pipeline identifier

Example: pipeline_execution_id=Aliquid dicta hic ut illum aut labore.
pipeline_stage_id
string

Pipeline stage identifier

Example: pipeline_stage_id=Omnis quia aut dolor voluptatem.
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: gd
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 approvals

Create an approval resource

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

Org is the organisation identifier.

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

Project is the project identifier.

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

Account is the internal customer account ID.

Example: oz
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": "Eos explicabo iste tempore.",
  • "pipeline_stage_id": "Qui velit et.",
  • "status": "pending",
  • "workspace_id": "Eos porro debitis hic."
}
Response samples
application/json
{
  • "id": "Dolor quos sit."
}

show-approval approvals

Retrieve a single approval

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

Org is the organisation identifier.

Example: 7g
project
required
string [ 1 .. 128 ] characters

Project is the project identifier.

Example: p
id
required
string
Example: Dicta possimus omnis consequatur.
header Parameters
Harness-Account
required
string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: z
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": 4225609668149018000,
  • "status": "Incidunt ut cumque error voluptatem quis.",
  • "updated": 7537095670274729000
}

update-approval approvals

Update a single approval

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

Org is the organisation identifier.

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

Project is the project identifier.

Example: rap
id
required
string
Example: Eos nesciunt.
header Parameters
Harness-Account
required
string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: i
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": "rejected"
}