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

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=Inventore id ducimus.
pipeline_execution_id	string Pipeline identifier Example: pipeline_execution_id=Quis sint architecto quia.
status	Array of strings Status of the execution Example: status=Temporibus sint.&status=Quis qui perspiciatis expedita quo cumque.&status=Quaerat aliquam.
pipeline_name	string Pipeline name Example: pipeline_name=Et enim suscipit 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: 75

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

curl
Java
Go

Response samples

application/json

[{"account": "oks",
"created": 3592506659952863000,
"org": "da",
"pipeline": "Ratione consequatur voluptatem voluptatum.",
"pipeline_execution_id": "Id doloremque nisi cumque incidunt.",
"pipeline_stage_id": "Quas qui.",
"project": "1p",
"status": "failure",
"workspace": "Quas repellendus ut illum ad."
},
{"account": "oks",
"created": 3592506659952863000,
"org": "da",
"pipeline": "Ratione consequatur voluptatem voluptatum.",
"pipeline_execution_id": "Id doloremque nisi cumque incidunt.",
"pipeline_stage_id": "Quas qui.",
"project": "1p",
"status": "failure",
"workspace": "Quas repellendus ut illum ad."
}
]

Create execution

Create a new execution.

Securityx-api-key

Request

path Parameters

org required	string [ 1 .. 128 ] characters Org is the organisation identifier. Example: 2
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: xui

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: 04

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

Payload
curl
Java
Go

application/json

{"pipeline": "Non ad.",
"pipeline_execution_id": "Voluptatem totam non numquam odit nesciunt.",
"pipeline_stage_id": "Sunt sed.",
"workspace": "Enim sit quia ab dolor dolores."
}

Response samples

application/json

{"account": "1q",
"created": 7717439340271189000,
"org": "5y3",
"pipeline": "Et alias perspiciatis odit eligendi.",
"pipeline_execution_id": "Id nostrum reprehenderit accusantium.",
"pipeline_stage_id": "Est et aut temporibus.",
"project": "r",
"status": "success",
"workspace": "Esse cum quisquam ut quo alias."
}

Show execution

Show an individual execution.

Securityx-api-key

Request

path Parameters

org required	string [ 1 .. 128 ] characters Org is the organisation identifier. Example: jo
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: gg
pipeline_execution_id required	string [ 1 .. 128 ] characters Pipeline execution ID Example: e9
pipeline_stage_id required	string [ 1 .. 128 ] characters Pipeline execution stage ID Example: o

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: 7f

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

curl
Java
Go

Response samples

application/json

{"account": "qmy",
"created": 5921136341702465000,
"org": "zd",
"pipeline": "Tempore vel nobis sapiente quis.",
"pipeline_execution_id": "Quod dolore quia sunt repudiandae.",
"pipeline_stage_id": "Corrupti repellendus explicabo.",
"project": "rx",
"status": "none",
"workspace": "Explicabo ut."
}

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: rg
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: fc
pipeline_execution_id required	string [ 1 .. 128 ] characters Pipeline execution ID Example: 5j
pipeline_stage_id required	string [ 1 .. 128 ] characters Pipeline execution stage ID Example: 3p

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: e

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

Payload
curl
Java
Go

application/json

{"audit": {"git_audit_data": {"hash": "8",
"name": "Officia voluptatem ullam odit porro qui.",
"repo_url": "t5q",
"type": "branch, tag"
}
}
}

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: i
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: jo
pipeline_execution_id required	string [ 1 .. 128 ] characters Pipeline execution ID Example: eh

query Parameters

pipeline_stage_id

string

Default: ""

Example: pipeline_stage_id=Quia quo sit distinctio.

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: h

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

curl
Java
Go

Response samples

application/json

{"currency": "Maiores quisquam unde illum placeat.",
"diff": {"Perferendis ut est voluptate.": {"current_monthly_cost": "Corrupti dignissimos magnam rerum.",
"diff": [{"current_monthly_cost": "Quae iste ab temporibus.",
"diff_monthly_cost": "Molestias qui.",
"name": "Sunt eum fugiat aliquid perspiciatis neque error.",
"percentage_change_monthly_cost": 6718517774354382000,
"previous_monthly_cost": "Tempora maxime corporis quo voluptas.",
"subresources": {"Rerum aut.": {"current_monthly_cost": "Rerum eos dolor.",
"diff_monthly_cost": "Quisquam nihil.",
"percentage_change_monthly_cost": 5491944409019695000,
"previous_monthly_cost": "Provident eum fugiat."
},
"Voluptatem laudantium occaecati qui.": {"current_monthly_cost": "Rerum eos dolor.",
"diff_monthly_cost": "Quisquam nihil.",
"percentage_change_monthly_cost": 5491944409019695000,
"previous_monthly_cost": "Provident eum fugiat."
}
}
},
{"current_monthly_cost": "Quae iste ab temporibus.",
"diff_monthly_cost": "Molestias qui.",
"name": "Sunt eum fugiat aliquid perspiciatis neque error.",
"percentage_change_monthly_cost": 6718517774354382000,
"previous_monthly_cost": "Tempora maxime corporis quo voluptas.",
"subresources": {"Rerum aut.": {"current_monthly_cost": "Rerum eos dolor.",
"diff_monthly_cost": "Quisquam nihil.",
"percentage_change_monthly_cost": 5491944409019695000,
"previous_monthly_cost": "Provident eum fugiat."
},
"Voluptatem laudantium occaecati qui.": {"current_monthly_cost": "Rerum eos dolor.",
"diff_monthly_cost": "Quisquam nihil.",
"percentage_change_monthly_cost": 5491944409019695000,
"previous_monthly_cost": "Provident eum fugiat."
}
}
}
],
"diff_monthly_cost": "Quidem est impedit alias aut eaque.",
"percentage_change_monthly_cost": 8230374679969997000,
"previous_monthly_cost": "Quasi voluptate."
}
},
"diff_total_monthly_cost": "Incidunt sunt voluptatem sit autem sed.",
"past_total_monthly_cost": "Impedit voluptate consequuntur cupiditate.",
"percentage_change_total_monthly_cost": 2242607757095590400,
"total_monthly_cost": "Non voluptas nisi consectetur ut."
}

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: nw8
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: 34
pipeline_execution_id required	string [ 1 .. 128 ] characters Pipeline execution ID Example: 20

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=Necessitatibus nihil et qui maxime enim architecto.

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: seb

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

curl
Java
Go

Response samples

application/json

{"drift_changes": [{"change": "added",
"change_count": 10,
"changes": {"Repellendus et exercitationem nihil ut numquam.": {"change": "added",
"drift": true,
"new": "new value",
"old": "old value",
"sensitive": true
}
},
"drift": false,
"module": "full_stack",
"name": "app_server",
"provider": "AWS",
"type": "S3 Bucket"
},
{"change": "added",
"change_count": 10,
"changes": {"Repellendus et exercitationem nihil ut numquam.": {"change": "added",
"drift": true,
"new": "new value",
"old": "old value",
"sensitive": true
}
},
"drift": false,
"module": "full_stack",
"name": "app_server",
"provider": "AWS",
"type": "S3 Bucket"
},
{"change": "added",
"change_count": 10,
"changes": {"Repellendus et exercitationem nihil ut numquam.": {"change": "added",
"drift": true,
"new": "new value",
"old": "old value",
"sensitive": true
}
},
"drift": false,
"module": "full_stack",
"name": "app_server",
"provider": "AWS",
"type": "S3 Bucket"
},
{"change": "added",
"change_count": 10,
"changes": {"Repellendus et exercitationem nihil ut numquam.": {"change": "added",
"drift": true,
"new": "new value",
"old": "old value",
"sensitive": true
}
},
"drift": false,
"module": "full_stack",
"name": "app_server",
"provider": "AWS",
"type": "S3 Bucket"
}
],
"outputs": [{"change": "added",
"name": "instance_public_ip",
"new": "new value",
"old": "old value",
"sensitive": true
},
{"change": "added",
"name": "instance_public_ip",
"new": "new value",
"old": "old value",
"sensitive": true
}
],
"pipeline_execution": "Consequatur reprehenderit commodi sequi.",
"pipeline_stage": "Nulla asperiores.",
"planned_changes": [{"change": "added",
"change_count": 10,
"changes": {"Repellendus et exercitationem nihil ut numquam.": {"change": "added",
"drift": true,
"new": "new value",
"old": "old value",
"sensitive": true
}
},
"drift": false,
"module": "full_stack",
"name": "app_server",
"provider": "AWS",
"type": "S3 Bucket"
},
{"change": "added",
"change_count": 10,
"changes": {"Repellendus et exercitationem nihil ut numquam.": {"change": "added",
"drift": true,
"new": "new value",
"old": "old value",
"sensitive": true
}
},
"drift": false,
"module": "full_stack",
"name": "app_server",
"provider": "AWS",
"type": "S3 Bucket"
},
{"change": "added",
"change_count": 10,
"changes": {"Repellendus et exercitationem nihil ut numquam.": {"change": "added",
"drift": true,
"new": "new value",
"old": "old value",
"sensitive": true
}
},
"drift": false,
"module": "full_stack",
"name": "app_server",
"provider": "AWS",
"type": "S3 Bucket"
},
{"change": "added",
"change_count": 10,
"changes": {"Repellendus et exercitationem nihil ut numquam.": {"change": "added",
"drift": true,
"new": "new value",
"old": "old value",
"sensitive": true
}
},
"drift": false,
"module": "full_stack",
"name": "app_server",
"provider": "AWS",
"type": "S3 Bucket"
}
],
"resources": [{"attributes": {"ami": "ami-830c94ec",
"instance_type": "t2.micro"
},
"drift_attributes": {"instance_type": "t2.nano"
},
"drift_status": "changed",
"module": "full_stack",
"name": "app_server",
"provider": "AWS",
"sensitive_attributes": ["instance_type"
],
"type": "S3 Bucket"
},
{"attributes": {"ami": "ami-830c94ec",
"instance_type": "t2.micro"
},
"drift_attributes": {"instance_type": "t2.nano"
},
"drift_status": "changed",
"module": "full_stack",
"name": "app_server",
"provider": "AWS",
"sensitive_attributes": ["instance_type"
],
"type": "S3 Bucket"
},
{"attributes": {"ami": "ami-830c94ec",
"instance_type": "t2.micro"
},
"drift_attributes": {"instance_type": "t2.nano"
},
"drift_status": "changed",
"module": "full_stack",
"name": "app_server",
"provider": "AWS",
"sensitive_attributes": ["instance_type"
],
"type": "S3 Bucket"
}
],
"workspace_id": "Dolores id mollitia."
}

➔ Next to module-registry

executions

List executions

path Parameters

query Parameters

header Parameters

Create execution

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Show execution

path Parameters

header Parameters

Update execution

path Parameters

header Parameters

Request Body schema: application/jsonrequired

List cost changes

path Parameters

query Parameters

header Parameters

List resource changes

path Parameters

query Parameters

header Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required