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

Project is the project identifier.

Example: he
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=Ut beatae dolore et quis porro.
pipeline_execution_id
string

Pipeline identifier

Example: pipeline_execution_id=Iste ut officia delectus voluptatem.
status
Array of strings

Status of the execution

Example: status=Consequuntur voluptates est et dignissimos laudantium enim.&status=Dignissimos voluptas tempore.&status=Consectetur aut at illo distinctio dolor.&status=Vel perspiciatis.
pipeline_name
string

Pipeline name

Example: pipeline_name=Explicabo vel explicabo impedit.
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: ou
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:  cr
project
required
string  [ 1 .. 128 ] characters 
Project is the project identifier.


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


 
 Example:  c
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": "Vel id eum sed.",
  • "pipeline_execution_id": "Nam et.",
  • "pipeline_stage_id": "Molestiae ipsa culpa.",
  • "workspace": "Vero similique quod molestiae a."
}
Response samples 
application/json
{
  • "account": "8",
  • "created": 1629204089804572400,
  • "org": "gi",
  • "pipeline": "Non laboriosam.",
  • "pipeline_execution_id": "Necessitatibus vero a veritatis animi.",
  • "pipeline_stage_id": "Praesentium sapiente voluptatum deleniti.",
  • "project": "jm7",
  • "status": "failure",
  • "workspace": "Deleniti placeat autem repellendus qui consequatur aliquam."
}
Show execution
Show an individual execution.


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


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


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


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


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


 
 Example:  f8
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": "fo0",
  • "created": 7890993953850407000,
  • "org": "193",
  • "pipeline": "Vel tenetur.",
  • "pipeline_execution_id": "Quisquam eos.",
  • "pipeline_stage_id": "Repellendus officiis et dicta sed autem rerum.",
  • "project": "f",
  • "status": "failure",
  • "workspace": "Ad qui dolorem."
}
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:  3
project
required
string  [ 1 .. 128 ] characters 
Project is the project identifier.


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


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


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


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


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


 
 Example:  8
query Parameters
pipeline_stage_id
string
 Default:  ""
 
 Example:  pipeline_stage_id=Provident voluptate voluptatem et et tempore voluptatem.
header Parameters
Harness-Account
required
string  [ 1 .. 128 ] characters 
Account is the internal customer account ID.


 
 Example:  sl1
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": "Ut numquam sed provident.",
  • "diff": {
    },
  • "diff_total_monthly_cost": "Iste repudiandae perferendis aut voluptatibus qui voluptatem.",
  • "past_total_monthly_cost": "Et libero fugiat consequatur ea repellendus.",
  • "percentage_change_total_monthly_cost": 8422739948968771000,
  • "stage_execution_id": "Aliquid voluptates natus et aspernatur autem.",
  • "stage_id": "Incidunt explicabo ullam nesciunt voluptate sequi beatae.",
  • "total_monthly_cost": "Minima at voluptatem in aut ut omnis.",
  • "workspace_id": "Dicta adipisci porro consequatur cupiditate."
}
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:  h
project
required
string  [ 1 .. 128 ] characters 
Project is the project identifier.


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


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


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


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


 
 Example:  pq
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=Aut facere et.
header Parameters
Harness-Account
required
string  [ 1 .. 128 ] characters 
Account is the internal customer account ID.


 
 Example:  jmu
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": "Molestiae qui ea sit eaque.",
  • "pipeline_stage": "Alias blanditiis.",
  • "planned_changes": [
    ],
  • "resources": [
    ],
  • "stage_id": "Repellendus mollitia.",
  • "workspace_id": "Rerum eos voluptas et."
}
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:  55
project
required
string  [ 1 .. 128 ] characters 
Project is the project identifier.


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


 
 Example:  d2n
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:  bx6
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