Harness

executions

Executions Service handles the API for workflow executions.

At this time it is a read-only API with no abilty to directly create or edit executions. Instead these are triggered from the Workspaces Service.

List executions

List all executions.

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

Org is the organisation identifier.

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

Project is the project identifier.

Example: 30
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=Quos voluptatum.
pipeline_execution_id
string

Pipeline identifier

Example: pipeline_execution_id=Qui mollitia velit vel.
status
Array of strings

Status of the execution

Example: status=Nam rerum non sit earum.&status=Fuga ut impedit recusandae.&status=Aut sed dicta deserunt dolores.
pipeline_name
string

Pipeline name

Example: pipeline_name=Adipisci alias saepe neque dolores.
start_time
integer <int64>

Specify the start time for the query

Example: start_time=1691150743950
end_time
integer <int64>

Specify the end time limit for the query

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

Account is the internal customer account ID.

Example: me8
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}/executions
Request samples 
Response samples 
application/json
[
  • {
    },
  • {
    }
]
Create execution
Create a new execution.


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


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


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


 
 Example:  027
Request Body schema: application/json
required
pipeline
required
string
The unique identifier for the associated pipeline


 
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 stage


 
workspace
required
string
The unique identifier for the associated workspace


 
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}/executions
Request samples 
application/json
{
  • "pipeline": "In ipsum numquam aliquid.",
  • "pipeline_execution_id": "Ducimus et fugit assumenda.",
  • "pipeline_stage_id": "Maxime aut vitae.",
  • "workspace": "Ab quasi tenetur."
}
Response samples 
application/json
{
  • "account": "l",
  • "created": 7684193389631247000,
  • "org": "qa1",
  • "pipeline": "Dolores voluptatem et sint.",
  • "pipeline_execution_id": "Voluptatem sint fuga aut incidunt quidem autem.",
  • "pipeline_stage_id": "A culpa quod eveniet qui.",
  • "project": "1e",
  • "status": "none",
  • "workspace": "Quo architecto omnis."
}
Show execution
Show an individual execution.


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


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


 
 Example:  9e
pipeline_execution_id
required
string  [ 1 .. 128 ] characters 
Pipeline execution ID


 
 Example:  b4
pipeline_stage_id
required
string  [ 1 .. 128 ] characters 
Pipeline execution stage ID


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


 
 Example:  k4
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}/executions/{pipeline_execution_id}/{pipeline_stage_id}
Request samples 
Response samples 
application/json
{
  • "account": "s",
  • "created": 7995441205250772000,
  • "org": "s2i",
  • "pipeline": "Asperiores dicta libero natus.",
  • "pipeline_execution_id": "Illo sed ut.",
  • "pipeline_stage_id": "Est porro inventore id at labore soluta.",
  • "project": "q",
  • "status": "none",
  • "workspace": "Incidunt quis."
}
Update execution
Modify an individual execution by adding audit data.


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


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


 
 Example:  pgb
pipeline_execution_id
required
string  [ 1 .. 128 ] characters 
Pipeline execution ID


 
 Example:  gl
pipeline_stage_id
required
string  [ 1 .. 128 ] characters 
Pipeline execution stage ID


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


 
 Example:  ul
Request Body schema: application/json
required
object (Audit) 
 
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}/executions/{pipeline_execution_id}/{pipeline_stage_id}/audit-event
Request samples 
application/json
{
  • "audit": {
    }
}
List cost changes
List cost changes from the latest plan and last applied state for the current execution.


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


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


 
 Example:  9
pipeline_execution_id
required
string  [ 1 .. 128 ] characters 
Pipeline execution ID


 
 Example:  1c
query Parameters
pipeline_stage_id
string
 Default:  ""
 
 Example:  pipeline_stage_id=Commodi laboriosam eligendi aut aut error expedita.
header Parameters
Harness-Account
required
string  [ 1 .. 128 ] characters 
Account is the internal customer account ID.


 
 Example:  0i
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}/executions/{pipeline_execution_id}/cost-changes
Request samples 
Response samples 
application/json
{
  • "currency": "Vel temporibus doloribus earum.",
  • "diff": {
    },
  • "diff_total_monthly_cost": "Repellat sunt doloribus praesentium.",
  • "past_total_monthly_cost": "Officia natus dignissimos repellat tempora sit id.",
  • "percentage_change_total_monthly_cost": 3032782434846140400,
  • "total_monthly_cost": "Qui perferendis voluptatem est."
}
List resource changes
List resource changes from the latest plan and state for this execution.


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


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


 
 Example:  7n
pipeline_execution_id
required
string  [ 1 .. 128 ] characters 
Pipeline execution ID


 
 Example:  qa
query Parameters
exclude_state
boolean
 Default:  false
When true, exclude values from the state in the response


 
 Example:  exclude_state=false
pipeline_stage_id
string
 Default:  ""
 
 Example:  pipeline_stage_id=Et autem possimus et quae consequatur doloribus.
header Parameters
Harness-Account
required
string  [ 1 .. 128 ] characters 
Account is the internal customer account ID.


 
 Example:  o3
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}/executions/{pipeline_execution_id}/resource-changes
Request samples 
Response samples 
application/json
{
  • "drift_changes": [
    ],
  • "outputs": [
    ],
  • "pipeline_execution": "Ipsa quas.",
  • "pipeline_stage": "Sapiente velit ut sint.",
  • "planned_changes": [
    ],
  • "resources": [
    ],
  • "workspace_id": "Soluta distinctio voluptate tempora perspiciatis et nobis."
}
➔ Next to module-registry