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

Project is the project identifier.

Example: f6
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=Et ab et ab qui.
pipeline_execution_id
string

Pipeline identifier

Example: pipeline_execution_id=Deserunt et est.
status
Array of strings

Status of the execution

Example: status=Ducimus consequatur aut.&status=Occaecati consequatur excepturi vero.
pipeline_name
string

Pipeline name

Example: pipeline_name=Quos quidem est unde repudiandae quidem incidunt.
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: v
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:  km
project
required
string  [ 1 .. 128 ] characters 
Project is the project identifier.


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


 
 Example:  qn
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": "Quo architecto.",
  • "pipeline_execution_id": "Explicabo mollitia incidunt alias aut libero eos.",
  • "pipeline_stage_id": "Impedit ut debitis in exercitationem voluptates ipsam.",
  • "workspace": "Qui fugiat dignissimos a."
}
Response samples 
application/json
{
  • "account": "4",
  • "created": 159844508474892540,
  • "org": "bc",
  • "pipeline": "Iste praesentium earum.",
  • "pipeline_execution_id": "Voluptatem reiciendis nihil omnis cumque.",
  • "pipeline_stage_id": "Fuga nihil incidunt accusamus hic quis.",
  • "project": "x",
  • "status": "success",
  • "workspace": "Occaecati aspernatur."
}
Show execution
Show an individual execution.


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


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


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


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


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


 
 Example:  b9
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": "nu",
  • "created": 58120768662255090,
  • "org": "aq",
  • "pipeline": "Esse cum quisquam ut quo alias.",
  • "pipeline_execution_id": "Dolorum cumque ut cumque aut quia praesentium.",
  • "pipeline_stage_id": "Sint laboriosam iste iusto totam id nostrum.",
  • "project": "2z",
  • "status": "failure",
  • "workspace": "Accusantium aperiam est et aut temporibus."
}
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:  c
project
required
string  [ 1 .. 128 ] characters 
Project is the project identifier.


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


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


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


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


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


 
 Example:  u6
query Parameters
pipeline_stage_id
string
 Default:  ""
 
 Example:  pipeline_stage_id=Inventore maxime ipsa.
header Parameters
Harness-Account
required
string  [ 1 .. 128 ] characters 
Account is the internal customer account ID.


 
 Example:  2u
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": "Iste et.",
  • "diff": {
    },
  • "diff_total_monthly_cost": "Ut commodi.",
  • "past_total_monthly_cost": "Porro ipsa odit corrupti.",
  • "percentage_change_total_monthly_cost": 3846073411861896700,
  • "total_monthly_cost": "Cumque est sunt est quia."
}
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:  l
project
required
string  [ 1 .. 128 ] characters 
Project is the project identifier.


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


 
 Example:  26
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=Ullam voluptatem perferendis porro.
header Parameters
Harness-Account
required
string  [ 1 .. 128 ] characters 
Account is the internal customer account ID.


 
 Example:  gj
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": "Harum odio sed est.",
  • "pipeline_stage": "Et atque dolorum officia.",
  • "planned_changes": [
    ],
  • "resources": [
    ],
  • "workspace_id": "Ex officiis rerum impedit."
}
➔ Next to module-registry