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 executions

List all executions.

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

Org is the organisation identifier.

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

Project is the project identifier.

Example: ny
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=Architecto sequi perferendis unde iure.
pipeline_execution_id
string

Pipeline identifier

Example: pipeline_execution_id=A quod sequi impedit velit.
status
Array of strings

Status of the execution

Example: status=Rerum consequatur vel ut sint dolor.&status=Velit voluptas sunt voluptatem ullam.&status=Quod ut molestias aliquid deleniti nesciunt nemo.&status=Mollitia quasi dolore.
pipeline_name
string

Pipeline name

Example: pipeline_name=Enim minus voluptatem fuga.
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: tk5
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 executions

Create a new execution.

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

Org is the organisation identifier.

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

Project is the project identifier.

Example: z2
header Parameters
Harness-Account
required
string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: a
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": "Consequatur et veritatis aspernatur quia eligendi.",
  • "pipeline_execution_id": "Et vel quisquam maiores.",
  • "pipeline_stage_id": "Magni unde culpa aut.",
  • "workspace": "Maxime aliquam eveniet."
}
Response samples
application/json
{
  • "account": "hvi",
  • "audit": "Unde dolores vitae natus.",
  • "created": 428375767912060860,
  • "org": "qoo",
  • "pipeline": "Iusto enim.",
  • "pipeline_execution_id": "Mollitia laboriosam minus assumenda.",
  • "pipeline_stage_id": "Quod molestiae.",
  • "project": "xjt",
  • "status": "success",
  • "workspace": "Adipisci est eum est ipsa dolor laborum."
}

show-execution executions

Show an individual execution.

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

Org is the organisation identifier.

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

Project is the project identifier.

Example: wqy
pipeline_execution_id
required
string [ 1 .. 128 ] characters

Pipeline execution ID

Example: y7
pipeline_stage_id
required
string [ 1 .. 128 ] characters

Pipeline execution stage ID

Example: 7jo
header Parameters
Harness-Account
required
string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: 4rh
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": "6wt",
  • "audit": "Aut eum alias ex molestiae.",
  • "created": 3326696397722817000,
  • "org": "5oz",
  • "pipeline": "Sint aut et sit quis.",
  • "pipeline_execution_id": "Error ducimus sed sed enim expedita et.",
  • "pipeline_stage_id": "Rerum rerum fugiat.",
  • "project": "w",
  • "status": "success",
  • "workspace": "Officia eligendi assumenda placeat vero dolorem."
}

modify-execution executions

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

Project is the project identifier.

Example: bh5
pipeline_execution_id
required
string [ 1 .. 128 ] characters

Pipeline execution ID

Example: b2
pipeline_stage_id
required
string [ 1 .. 128 ] characters

Pipeline execution stage ID

Example: 2r8
header Parameters
Harness-Account
required
string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: em
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 executions

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

Project is the project identifier.

Example: 3
pipeline_execution_id
required
string [ 1 .. 128 ] characters

Pipeline execution ID

Example: nma
header Parameters
Harness-Account
required
string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: e1l
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": "Omnis est nam occaecati distinctio.",
  • "diff": {
    },
  • "diff_total_monthly_cost": "Quis nesciunt sunt possimus.",
  • "past_total_monthly_cost": "Consequatur hic magni suscipit sint dolorum odit.",
  • "percentage_change_total_monthly_cost": 1985312952530086700,
  • "total_monthly_cost": "Ut necessitatibus placeat."
}

list-resource-changes executions

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

Project is the project identifier.

Example: m
pipeline_execution_id
required
string [ 1 .. 128 ] characters

Pipeline execution ID

Example: 3
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: pp
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": "Ea quo voluptas.",
  • "planned_changes": [
    ],
  • "resources": [
    ],
  • "workspace_id": "Nihil quos inventore magni labore eum reiciendis."
}