Harness

executions

Executions Service handles the API for workflow executions.

At this time it is a read-only API with no ability 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: r
project
required
string [ 1 .. 128 ] characters

Project is the project identifier.

Example: g
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=Doloremque aut.
pipeline_execution_id
string

Pipeline identifier

Example: pipeline_execution_id=Perspiciatis qui quidem aut et alias nihil.
status
Array of strings

Status of the execution

Example: status=Hic dolorem minima corrupti reiciendis.&status=Maiores pariatur possimus exercitationem dolores dolores.&status=Soluta deleniti ducimus nobis dolorem.
pipeline_name
string

Pipeline name

Example: pipeline_name=Libero officia nemo natus voluptatum.
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: nds
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:  dav
project
required
string  [ 1 .. 128 ] characters 
Project is the project identifier.


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


 
 Example:  cpi
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": "Repellat quia ab at et nobis.",
  • "pipeline_execution_id": "Eos id velit.",
  • "pipeline_stage_id": "Hic incidunt.",
  • "workspace": "Sed quia."
}
Response samples 
application/json
{
  • "account": "sil",
  • "created": 3773351942269803000,
  • "org": "8c3",
  • "pipeline": "Quaerat velit voluptates veritatis assumenda.",
  • "pipeline_execution_id": "Consequatur rerum qui aut.",
  • "pipeline_stage_id": "Deleniti delectus.",
  • "project": "t3f",
  • "status": "none",
  • "workspace": "Amet et illo quod nisi tempore."
}
Show execution
Show an individual execution.


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


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


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


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


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


 
 Example:  i4
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": "u",
  • "created": 2779238684845977600,
  • "org": "kj",
  • "pipeline": "Ratione veritatis ut et quia.",
  • "pipeline_execution_id": "Possimus vitae qui commodi qui explicabo.",
  • "pipeline_stage_id": "Rerum ducimus officia at dolorum sed tempore.",
  • "project": "xo0",
  • "status": "none",
  • "workspace": "Aut porro mollitia quia in quo."
}
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:  37j
project
required
string  [ 1 .. 128 ] characters 
Project is the project identifier.


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


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


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


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


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


 
 Example:  s0m
query Parameters
pipeline_stage_id
string
 Default:  ""
 
 Example:  pipeline_stage_id=Aliquid maxime est minus ut voluptatum et.
header Parameters
Harness-Account
required
string  [ 1 .. 128 ] characters 
Account is the internal customer account ID.


 
 Example:  ktm
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": "Labore error consequatur excepturi.",
  • "diff": {
    },
  • "diff_total_monthly_cost": "Ut pariatur adipisci veniam et enim voluptate.",
  • "past_total_monthly_cost": "Voluptas neque.",
  • "percentage_change_total_monthly_cost": 4743078471674037000,
  • "stage_execution_id": "Eum sunt ipsam placeat quis.",
  • "stage_id": "Similique atque tempore porro error.",
  • "total_monthly_cost": "Excepturi voluptate suscipit neque aliquid quam voluptas.",
  • "workspace_id": "Adipisci voluptatibus aut aliquam molestiae."
}
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:  l
project
required
string  [ 1 .. 128 ] characters 
Project is the project identifier.


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


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


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


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


 
 Example:  g
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=Ducimus ipsum officia minus.
header Parameters
Harness-Account
required
string  [ 1 .. 128 ] characters 
Account is the internal customer account ID.


 
 Example:  oca
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
{
  • "data_sources": [
    ],
  • "drift_changes": [
    ],
  • "outputs": [
    ],
  • "pipeline_execution": "Porro id corrupti quod.",
  • "pipeline_stage": "Ipsam corporis iste harum.",
  • "planned_changes": [
    ],
  • "resources": [
    ],
  • "stage_id": "Qui dignissimos molestiae repudiandae nihil voluptatem.",
  • "workspace_id": "Nisi ipsum quisquam et veritatis consequatur non."
}
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:  qiq
project
required
string  [ 1 .. 128 ] characters 
Project is the project identifier.


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


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