Harness

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: ok
project
required
string [ 1 .. 128 ] characters

Project is the project identifier.

Example: i
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=Blanditiis quia dolorem suscipit sunt.
pipeline_execution_id
string

Pipeline identifier

Example: pipeline_execution_id=Vel amet ut nesciunt modi ut.
pipeline_stage_id
string

Pipeline stage identifier

Example: pipeline_stage_id=Ipsa dolor ut modi enim.
status_type
string

Status of the approval step

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

Account is the internal customer account ID.

Example: w
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:  s
project
required
string  [ 1 .. 128 ] characters 
Project is the project identifier.


 
 Example:  wxv
header Parameters
Harness-Account
required
string  [ 1 .. 128 ] characters 
Account is the internal customer account ID.


 
 Example:  j
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 voluptas magnam quia quae.",
  • "pipeline_stage_id": "Nisi quibusdam dolores nam.",
  • "status": "rejected",
  • "workspace_id": "Cum totam id laborum velit ratione."
}
Response samples 
application/json
{
  • "id": "Vel est velit."
}
Show approval
Retrieve a single approval


Securityx-api-key 
Request 
path Parameters
org
required
string  [ 1 .. 128 ] characters 
Org is the organisation identifier.


 
 Example:  6rq
project
required
string  [ 1 .. 128 ] characters 
Project is the project identifier.


 
 Example:  3h4
id
required
string <uuid> 
 
 Example:  8d31608f-69a3-4245-8ef5-d79a3f6f0c04
header Parameters
Harness-Account
required
string  [ 1 .. 128 ] characters 
Account is the internal customer account ID.


 
 Example:  g0
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": 5181654596807823000,
  • "status": "Vel aspernatur accusamus.",
  • "updated": 2748746063503352300
}
Update approval
Update a single approval


Securityx-api-key 
Request 
path Parameters
org
required
string  [ 1 .. 128 ] characters 
Org is the organisation identifier.


 
 Example:  86l
project
required
string  [ 1 .. 128 ] characters 
Project is the project identifier.


 
 Example:  9b
id
required
string <uuid> 
 
 Example:  8acb7ce5-4b17-43e0-ab23-1249e3aaf55e
header Parameters
Harness-Account
required
string  [ 1 .. 128 ] characters 
Account is the internal customer account ID.


 
 Example:  zq
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": "pending"
}
➔ Next to costs