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

Project is the project identifier.

Example: o2r
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=Reprehenderit sint voluptatem eveniet.
pipeline_execution_id
string

Pipeline identifier

Example: pipeline_execution_id=Excepturi sit veritatis a unde esse voluptatem.
status
Array of strings

Status of the execution

Example: status=Excepturi quidem sit quia consequatur.&status=Blanditiis doloribus provident eius.&status=Facere et occaecati quia.&status=Ut nostrum quis.
pipeline_name
string

Pipeline name

Example: pipeline_name=Cum alias ad velit autem quibusdam.
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: plq
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:  w7
project
required
string  [ 1 .. 128 ] characters 
Project is the project identifier.


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


 
 Example:  s
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": "Recusandae et facere enim.",
  • "pipeline_execution_id": "Ullam incidunt amet explicabo aut animi odit.",
  • "pipeline_stage_id": "Est id aut hic doloremque illum.",
  • "workspace": "Nisi ad impedit officiis voluptas id."
}
Response samples 
application/json
{
  • "account": "t63",
  • "created": 4654093075427853000,
  • "org": "sik",
  • "pipeline": "Dolore repudiandae quo deleniti facere quaerat.",
  • "pipeline_execution_id": "Atque ullam dolorem tempora molestiae.",
  • "pipeline_stage_id": "Excepturi laborum esse porro consequatur cupiditate.",
  • "project": "wt",
  • "status": "success",
  • "workspace": "Qui natus tenetur delectus."
}
Show execution
Show an individual execution.


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


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


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


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


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


 
 Example:  k5
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": "cv4",
  • "created": 8044543531641960000,
  • "org": "xpj",
  • "pipeline": "Sed eius ut.",
  • "pipeline_execution_id": "Soluta vero quod labore autem.",
  • "pipeline_stage_id": "Illum ut.",
  • "project": "tr6",
  • "status": "failure",
  • "workspace": "Commodi et ut esse sit nesciunt."
}
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:  9
project
required
string  [ 1 .. 128 ] characters 
Project is the project identifier.


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


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


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


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


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


 
 Example:  k
query Parameters
pipeline_stage_id
string
 Default:  ""
 
 Example:  pipeline_stage_id=Est nesciunt sed vel et quis impedit.
header Parameters
Harness-Account
required
string  [ 1 .. 128 ] characters 
Account is the internal customer account ID.


 
 Example:  rg
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": "Consectetur modi velit unde.",
  • "diff": {
    },
  • "diff_total_monthly_cost": "Repudiandae eaque dolores.",
  • "past_total_monthly_cost": "Cumque corporis voluptate.",
  • "percentage_change_total_monthly_cost": 7980470440027417000,
  • "stage_execution_id": "Eos modi recusandae consectetur repudiandae.",
  • "stage_id": "Hic voluptas et.",
  • "total_monthly_cost": "Ipsam ratione mollitia voluptate molestiae necessitatibus et.",
  • "workspace_id": "Aut velit ea laudantium nesciunt."
}
List cost changes for all stages
List cost changes for all stages 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:  7
project
required
string  [ 1 .. 128 ] characters 
Project is the project identifier.


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


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


 
 Example:  qqi
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-all-stages
Request samples 
Response samples 
application/json
[
  • {
    },
  • {
    },
  • {
    }
]
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:  d
project
required
string  [ 1 .. 128 ] characters 
Project is the project identifier.


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


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


 
 Example:  exclude_state=true
pipeline_stage_id
string
 Default:  ""
 
 Example:  pipeline_stage_id=Similique quas.
header Parameters
Harness-Account
required
string  [ 1 .. 128 ] characters 
Account is the internal customer account ID.


 
 Example:  ca6
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": "Provident amet.",
  • "pipeline_stage": "Et occaecati alias perspiciatis dolores.",
  • "planned_changes": [
    ],
  • "resources": [
    ],
  • "stage_id": "Suscipit inventore et deserunt animi blanditiis sed.",
  • "workspace_id": "Omnis quaerat."
}
List resource changes for all stages
List resource changes for all stages 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:  v
project
required
string  [ 1 .. 128 ] characters 
Project is the project identifier.


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


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


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


 
 Example:  a9l
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-all-stages
Request samples 
Response samples 
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]
➔ Next to module-registry