workspaces

Workspaces Service handles the API for managing workspaces and triggering workflows against them.

List all workspace tags

List all tags

Securityx-api-key

Request

path Parameters

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

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: 2

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}/tags

Request samples

curl
Java
Go

Response samples

application/json

["Ut sed consequatur dignissimos ipsam.",
"Sit repudiandae perspiciatis quis ipsum commodi."
]

Show workspace metrics

Show metrics for workspaces

Securityx-api-key

Request

path Parameters

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

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}/workspace-metrics

Request samples

curl
Java
Go

Response samples

application/json

{"status_counts": {"Beatae dicta pariatur omnis non sit.": 2191444395875456300,
"Deleniti voluptate.": 8366767685107204000,
"Harum sequi omnis facilis recusandae earum.": 3001416260091428000
}
}

List workspaces

List all workspaces.

Securityx-api-key

Request

path Parameters

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

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
searchTerm	string Default: "" Filter results by partial name match Example: searchTerm=mysta
sort	string Default: "name,ASC" Sort order for results Enum: "name,ASC" "name,DESC" "updated,ASC" "updated,DESC" Example: sort=name,ASC
status	Array of strings Status of the execution Example: status=Ipsa mollitia consequatur.&status=Quia ducimus sit alias dignissimos optio.&status=Est dolorum at sed quia ut sapiente.
tags	Array of strings Comma separated list of tags to filter by Example: tags=Facere consequatur repellat.&tags=Et sunt et.&tags=Optio aut saepe harum qui vero.&tags=Molestias tempore nemo veniam esse veritatis.

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: qq

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}/workspaces

Request samples

curl
Java
Go

Response samples

application/json

[{"account": "z",
"created": 4109748539834617300,
"description": "this is a more detailed explanation of the resource.",
"identifier": "o",
"name": "resource name",
"org": "k2",
"project": "mz",
"status": "provisioning",
"updated": 2033908952644987100
},
{"account": "z",
"created": 4109748539834617300,
"description": "this is a more detailed explanation of the resource.",
"identifier": "o",
"name": "resource name",
"org": "k2",
"project": "mz",
"status": "provisioning",
"updated": 2033908952644987100
},
{"account": "z",
"created": 4109748539834617300,
"description": "this is a more detailed explanation of the resource.",
"identifier": "o",
"name": "resource name",
"org": "k2",
"project": "mz",
"status": "provisioning",
"updated": 2033908952644987100
}
]

Create workspace

Create a new workspace.

Securityx-api-key

Request

path Parameters

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

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: h

Request Body schema: application/json
required

	object (AssociatedTemplate) AssociatedTemplate defines the template details with template_id and version.
budget	number <float> define the budget for a specific workspace
cost_breakdown_json	string cost_breakdown_json is the identifier to the breakdown cost file from the current execution that was applied successfully
cost_diff_json	string cost_diff_json is the identifier to the diff cost file between the previous and current successful executions
cost_estimation_enabled	boolean Default: false define if cost estimation operations will be performed in this workspace
	object List of default pipelines associated with this workspace and any per-workspace overrrides.
description	string Description provides long-form text about the resource.
required	object list of environment variables configured on the workspace.
identifier required	string [ 1 .. 128 ] characters Workspace identifier.
modules_json	string modules_json is the identifier of any modules metadata associated with this workspace
name required	string [ 1 .. 128 ] characters Name is the human readable name for the resource.
provider_connector required	string Provider Connector is the reference to the connector for the infrastructure provider.
providers_json	string providers_json is the identifier of any modules metadata associated with this workspace
provisioner required	string Provisioner defines the provisioning tool to use. Enum: "terraform" "opentofu"
provisioner_version	string Default: "latest" Provisioner Version defines the tool version to use.
repository	string Repository is the name of the repository to use.
repository_branch	string Repository Branch in which the code should be accessed.
repository_commit	string Repository Commit/Tag in which the code should be accessed.
repository_connector	string Repository Connector is the reference to the connector to use for this code.
repository_path	string Default: "" Repository Path is the path in which the infra code resides.
repository_sha	string Repository SHA in which the code should be accessed.
repository_submodules	string Default: "false" repository_submodules is the instruction about whether to clone submodules in the pipeline step Enum: "false" "true" "recursive"
sparse_checkout	string List of patterens that will be used for sparse checkout option of git clone
state_checksum	string state_checksum is the sha-256 checksum of terraform state file
tags	string Tags associated with the workspace.
terraform_plan_json	string terraform_plan_json is the identifier to the current state file onl in JSON format.
terraform_state	string terraform_state is the identifier to the plan file used to create the latest state.
terraform_state_json	string terraform_state_json is the identifier to the plan file used to create the latest state only in JSON format.
	Array of objects (WorkspaceTerraformVariableFiles) define an array of terraform variables files that belong to a different repository
required	object list of terraform variables configured on the workspace.
variable_sets	Array of strings Optional Variable Sets as references

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}/workspaces

Request samples

Payload
curl
Java
Go

application/json

{"associated_template": {"template_id": "ne",
"version": "3e"
},
"budget": 0.99543875,
"cost_breakdown_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"cost_diff_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"cost_estimation_enabled": true,
"default_pipelines": {"Vero similique quod molestiae a.": {"project_pipeline": "Vel id eum sed.",
"workspace_pipeline": "Modi voluptatibus."
}
},
"description": "this is a more detailed explanation of the resource.",
"environment_variables": {"Deleniti eos reprehenderit.": {"key": "i4o",
"value": "Molestias iure voluptatum error quisquam.",
"value_type": "secret"
},
"Facere cum cupiditate cumque.": {"key": "i4o",
"value": "Molestias iure voluptatum error quisquam.",
"value_type": "secret"
},
"Ut quasi enim.": {"key": "i4o",
"value": "Molestias iure voluptatum error quisquam.",
"value_type": "secret"
}
},
"identifier": "zea",
"modules_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"name": "resource name",
"provider_connector": "Quis enim.",
"providers_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"provisioner": "terraform",
"provisioner_version": "Non magni eum est itaque.",
"repository": "Quia ut molestiae blanditiis nihil quisquam.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Est iste et alias ipsa reprehenderit.",
"repository_path": "",
"repository_sha": "abc10ed",
"repository_submodules": "recursive",
"sparse_checkout": "Eligendi eligendi.",
"state_checksum": "d21c1662d8ce2c74f24efdc8db93eb34473b86810aeccca4b1518f70b0ccde8f",
"tags": {"foo": "bar"
},
"terraform_plan_json": "f9e21473daaa2674d862b67a1339f4570e86de17",
"terraform_state": "fc1200c7a7aa52109d762a9f005b149abef01479",
"terraform_state_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"terraform_variable_files": [{"repository": "Numquam natus.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Ab nam et sunt molestiae.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{"repository": "Numquam natus.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Ab nam et sunt molestiae.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{"repository": "Numquam natus.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Ab nam et sunt molestiae.",
"repository_path": "",
"repository_sha": "abc10ed"
}
],
"terraform_variables": {"Quo omnis voluptas blanditiis veritatis animi.": {"key": "i4o",
"value": "Molestias iure voluptatum error quisquam.",
"value_type": "secret"
}
},
"variable_sets": ["Sed illum quo quasi.",
"Nam esse quidem ipsam necessitatibus ipsum."
]
}

Response samples

application/json

{"policy_evaluation": {"account_id": "XRQAjvT37acOiXx9PRaQMF",
"action": "onrun",
"created": 1636370209475,
"details": [{"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [{"deny_messages": ["deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n    \"deny\": [\n        \"deployment stage 'deploy' does not have a HarnessApproval step\"\n    ],\n    \"stages_with_approval\": []\n}",
"policy": {"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{"deny_messages": ["deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n    \"deny\": [\n        \"deployment stage 'deploy' does not have a HarnessApproval step\"\n    ],\n    \"stages_with_approval\": []\n}",
"policy": {"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
},
{"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [{"deny_messages": ["deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n    \"deny\": [\n        \"deployment stage 'deploy' does not have a HarnessApproval step\"\n    ],\n    \"stages_with_approval\": []\n}",
"policy": {"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{"deny_messages": ["deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n    \"deny\": [\n        \"deployment stage 'deploy' does not have a HarnessApproval step\"\n    ],\n    \"stages_with_approval\": []\n}",
"policy": {"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
},
{"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [{"deny_messages": ["deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n    \"deny\": [\n        \"deployment stage 'deploy' does not have a HarnessApproval step\"\n    ],\n    \"stages_with_approval\": []\n}",
"policy": {"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{"deny_messages": ["deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n    \"deny\": [\n        \"deployment stage 'deploy' does not have a HarnessApproval step\"\n    ],\n    \"stages_with_approval\": []\n}",
"policy": {"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
}
],
"entity": "7bbca5d4-e9f2-4955-9b2a-019ec4d3645e",
"entity_metadata": "7bbca5d4-e9f2-4955-9b2a-019ec4d3645e",
"id": 123,
"input": "",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline,service"
}
}

Destroy workspace

Deletes the given workspace.

Securityx-api-key

Request

path Parameters

org required	string [ 1 .. 128 ] characters Org is the organisation identifier. Example: 5at
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: b
identifier required	string [ 1 .. 128 ] characters Identifier is the project identifier. Example: lev

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: 6v

Responses

204

No Content 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.

delete/iacm/api/orgs/{org}/projects/{project}/workspaces/{identifier}

Request samples

curl
Java
Go

Show workspace

Show an individual workspace.

Securityx-api-key

Request

path Parameters

org required	string [ 1 .. 128 ] characters Org is the organisation identifier. Example: o90
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: wlc
identifier required	string [ 1 .. 128 ] characters Identifier is the project identifier. Example: im

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: 1

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}/workspaces/{identifier}

Request samples

curl
Java
Go

Response samples

application/json

{"account": "2g",
"associated_template": {"template_id": "a",
"version": "1"
},
"backend_locked": true,
"budget": 0.35236427,
"cost_breakdown_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"cost_diff_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"cost_estimation_enabled": true,
"created": 3579256232447716000,
"default_pipelines": {"Eos blanditiis cum suscipit dolorem mollitia.": {"project_pipeline": "Sit optio accusamus dolore similique.",
"workspace_pipeline": "Exercitationem voluptas tempora dolore."
},
"Soluta nihil blanditiis dolor dolor numquam consequuntur.": {"project_pipeline": "Sit optio accusamus dolore similique.",
"workspace_pipeline": "Exercitationem voluptas tempora dolore."
}
},
"description": "this is a more detailed explanation of the resource.",
"environment_variables": {"Dicta possimus itaque.": {"created": 6931149938485275000,
"key": "e",
"updated": 5256513641702357000,
"value": "Consectetur sint eos dignissimos.",
"value_type": "secret"
}
},
"identifier": "crt",
"modules_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"name": "resource name",
"org": "8p",
"project": "c7",
"provider_connector": "Nobis nisi vitae debitis nemo quo.",
"providers_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"provisioner": "terraform",
"provisioner_data": "Ab debitis veritatis commodi et sed.",
"provisioner_version": "Et repellendus.",
"repository": "Voluptatum facere sapiente fugit.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Ut totam.",
"repository_path": "",
"repository_sha": "abc10ed",
"repository_submodules": "recursive",
"sparse_checkout": "Temporibus voluptas ut fugit cumque.",
"state_checksum": "d21c1662d8ce2c74f24efdc8db93eb34473b86810aeccca4b1518f70b0ccde8f",
"status": "unknown",
"tags": {"foo": "bar"
},
"terraform_plan_json": "f9e21473daaa2674d862b67a1339f4570e86de17",
"terraform_state": "fc1200c7a7aa52109d762a9f005b149abef01479",
"terraform_state_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"terraform_variable_files": [{"repository": "Assumenda debitis eum.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Accusantium aut sit dolor libero voluptatem enim.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{"repository": "Assumenda debitis eum.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Accusantium aut sit dolor libero voluptatem enim.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{"repository": "Assumenda debitis eum.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Accusantium aut sit dolor libero voluptatem enim.",
"repository_path": "",
"repository_sha": "abc10ed"
}
],
"terraform_variables": {"Odio velit.": {"created": 6931149938485275000,
"key": "e",
"updated": 5256513641702357000,
"value": "Consectetur sint eos dignissimos.",
"value_type": "secret"
}
},
"updated": 3146444344596864500,
"variable_sets": ["Molestiae ducimus amet voluptate.",
"Rerum rerum explicabo recusandae sed dolore."
]
}

Update workspace

Updates the given workspace with new info.

Securityx-api-key

Request

path Parameters

org required	string [ 1 .. 128 ] characters Org is the organisation identifier. Example: 89
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: q
identifier required	string [ 1 .. 128 ] characters Workspace identifier. Example: h

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: y

Request Body schema: application/json
required

budget	number <float> define the budget for a specific workspace
cost_estimation_enabled	boolean Default: false define if cost estimation operations will be performed in this workspace
	object List of default pipelines associated with this workspace and any per-workspace overrrides.
description	string Description provides long-form text about the resource.
required	object list of environment variables configured on the workspace.
name required	string [ 1 .. 128 ] characters Name is the human readable name for the resource.
provider_connector required	string Provider Connector is the reference to the connector for the infrastructure provider.
provisioner required	string Provisioner defines the provisioning tool to use. Enum: "terraform" "opentofu"
provisioner_version	string Default: "latest" Provisioner Version defines the tool version to use.
repository	string Repository is the name of the repository to use.
repository_branch	string Repository Branch in which the code should be accessed.
repository_commit	string Repository Commit/Tag in which the code should be accessed.
repository_connector	string Repository Connector is the reference to the connector to use for this code.
repository_path	string Default: "" Repository Path is the path in which the infra code resides.
repository_sha	string Repository SHA in which the code should be accessed.
repository_submodules	string Default: "false" repository_submodules is the instruction about whether to clone submodules in the pipeline step Enum: "false" "true" "recursive"
sparse_checkout	string List of patterens that will be used for sparse checkout option of git clone
tags	string Tags associated with the workspace.
	Array of objects (WorkspaceTerraformVariableFiles) define an array of terraform variables files that belong to a different repository
required	object list of terraform variables configured on the workspace.
variable_sets	Array of strings Optional Variable Sets as references

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.

put/iacm/api/orgs/{org}/projects/{project}/workspaces/{identifier}

Request samples

Payload
curl
Java
Go

application/json

{"budget": 0.7906724,
"cost_estimation_enabled": true,
"default_pipelines": {"Et dicta adipisci porro consequatur cupiditate inventore.": {"project_pipeline": "Vel id eum sed.",
"workspace_pipeline": "Modi voluptatibus."
},
"Qui dolores ipsum autem ullam eum.": {"project_pipeline": "Vel id eum sed.",
"workspace_pipeline": "Modi voluptatibus."
}
},
"description": "this is a more detailed explanation of the resource.",
"environment_variables": {"Rerum aliquid voluptates.": {"key": "i4o",
"value": "Molestias iure voluptatum error quisquam.",
"value_type": "secret"
},
"Voluptate sequi.": {"key": "i4o",
"value": "Molestias iure voluptatum error quisquam.",
"value_type": "secret"
}
},
"name": "resource name",
"provider_connector": "At voluptatem in aut ut.",
"provisioner": "terraform",
"provisioner_version": "Voluptates error.",
"repository": "Dolore et.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Fugiat consequatur ea repellendus quisquam iste.",
"repository_path": "",
"repository_sha": "abc10ed",
"repository_submodules": "recursive",
"sparse_checkout": "Perferendis aut voluptatibus qui.",
"tags": {"foo": "bar"
},
"terraform_variable_files": [{"repository": "Numquam natus.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Ab nam et sunt molestiae.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{"repository": "Numquam natus.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Ab nam et sunt molestiae.",
"repository_path": "",
"repository_sha": "abc10ed"
}
],
"terraform_variables": {"Totam incidunt explicabo.": {"key": "i4o",
"value": "Molestias iure voluptatum error quisquam.",
"value_type": "secret"
}
},
"variable_sets": ["In recusandae et aut.",
"Dolorem eligendi corporis.",
"At nisi dolor harum illo necessitatibus qui.",
"Maiores rem necessitatibus natus odit."
]
}

Response samples

application/json

{"policy_evaluation": {"account_id": "XRQAjvT37acOiXx9PRaQMF",
"action": "onrun",
"created": 1636370209475,
"details": [{"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [{"deny_messages": ["deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n    \"deny\": [\n        \"deployment stage 'deploy' does not have a HarnessApproval step\"\n    ],\n    \"stages_with_approval\": []\n}",
"policy": {"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{"deny_messages": ["deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n    \"deny\": [\n        \"deployment stage 'deploy' does not have a HarnessApproval step\"\n    ],\n    \"stages_with_approval\": []\n}",
"policy": {"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
},
{"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [{"deny_messages": ["deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n    \"deny\": [\n        \"deployment stage 'deploy' does not have a HarnessApproval step\"\n    ],\n    \"stages_with_approval\": []\n}",
"policy": {"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{"deny_messages": ["deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n    \"deny\": [\n        \"deployment stage 'deploy' does not have a HarnessApproval step\"\n    ],\n    \"stages_with_approval\": []\n}",
"policy": {"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
},
{"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [{"deny_messages": ["deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n    \"deny\": [\n        \"deployment stage 'deploy' does not have a HarnessApproval step\"\n    ],\n    \"stages_with_approval\": []\n}",
"policy": {"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{"deny_messages": ["deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n    \"deny\": [\n        \"deployment stage 'deploy' does not have a HarnessApproval step\"\n    ],\n    \"stages_with_approval\": []\n}",
"policy": {"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
}
],
"entity": "7bbca5d4-e9f2-4955-9b2a-019ec4d3645e",
"entity_metadata": "7bbca5d4-e9f2-4955-9b2a-019ec4d3645e",
"id": 123,
"input": "",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline,service"
}
}

Force unlock workspace

Force unlock a workspace.

Securityx-api-key

Request

path Parameters

org required	string [ 1 .. 128 ] characters Org is the organisation identifier. Example: 8jo
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: zw7
identifier required	string [ 1 .. 128 ] characters Identifier is the project identifier. Example: zy

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: tek

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}/workspaces/{identifier}/actions/force-unlock

Request samples

curl
Java
Go

List modules

List modules associated with this workspace.

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: v1
identifier required	string [ 1 .. 128 ] characters Identifier is the project identifier. Example: 0a

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: e0o

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}/workspaces/{identifier}/modules

Request samples

curl
Java
Go

Response samples

application/json

[{"key": "ec2-instance_test",
"source": "registry.opentofu.org/terraform-aws-modules/ec2-instance/aws//examples/complete",
"version": "5.0.0"
},
{"key": "ec2-instance_test",
"source": "registry.opentofu.org/terraform-aws-modules/ec2-instance/aws//examples/complete",
"version": "5.0.0"
},
{"key": "ec2-instance_test",
"source": "registry.opentofu.org/terraform-aws-modules/ec2-instance/aws//examples/complete",
"version": "5.0.0"
},
{"key": "ec2-instance_test",
"source": "registry.opentofu.org/terraform-aws-modules/ec2-instance/aws//examples/complete",
"version": "5.0.0"
}
]

List resources

List resources associated with this workspace.

Securityx-api-key

Request

path Parameters

org required	string [ 1 .. 128 ] characters Org is the organisation identifier. Example: gl
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: mxl
identifier required	string [ 1 .. 128 ] characters Identifier is the project identifier. Example: eng

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: a

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}/workspaces/{identifier}/resources

Request samples

curl
Java
Go

Response samples

application/json

{"outputs": [{"name": "instance_public_ip",
"sensitive": true,
"value": "Totam consequatur."
},
{"name": "instance_public_ip",
"sensitive": true,
"value": "Totam consequatur."
},
{"name": "instance_public_ip",
"sensitive": true,
"value": "Totam consequatur."
}
],
"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"
}
]
}

Clone workspace

Clone the given workspace with new name.

Securityx-api-key

Request

path Parameters

org required	string [ 1 .. 128 ] characters Org is the organisation identifier. Example: 2tk
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: jv7
workspace required	string Example: Quaerat a laboriosam dicta similique natus at.

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: rb

Request Body schema: application/json
required

identifier required	string [ 1 .. 128 ] characters Workspace identifier.
name required	string [ 1 .. 128 ] characters Name is the human readable name for the resource.

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}/workspaces/{workspace}/clone

Request samples

Payload
curl
Java
Go

application/json

{"identifier": "k",
"name": "resource name"
}

Response samples

application/json

{"policy_evaluation": {"account_id": "XRQAjvT37acOiXx9PRaQMF",
"action": "onrun",
"created": 1636370209475,
"details": [{"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [{"deny_messages": ["deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n    \"deny\": [\n        \"deployment stage 'deploy' does not have a HarnessApproval step\"\n    ],\n    \"stages_with_approval\": []\n}",
"policy": {"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{"deny_messages": ["deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n    \"deny\": [\n        \"deployment stage 'deploy' does not have a HarnessApproval step\"\n    ],\n    \"stages_with_approval\": []\n}",
"policy": {"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
},
{"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [{"deny_messages": ["deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n    \"deny\": [\n        \"deployment stage 'deploy' does not have a HarnessApproval step\"\n    ],\n    \"stages_with_approval\": []\n}",
"policy": {"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{"deny_messages": ["deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n    \"deny\": [\n        \"deployment stage 'deploy' does not have a HarnessApproval step\"\n    ],\n    \"stages_with_approval\": []\n}",
"policy": {"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
},
{"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [{"deny_messages": ["deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n    \"deny\": [\n        \"deployment stage 'deploy' does not have a HarnessApproval step\"\n    ],\n    \"stages_with_approval\": []\n}",
"policy": {"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{"deny_messages": ["deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n    \"deny\": [\n        \"deployment stage 'deploy' does not have a HarnessApproval step\"\n    ],\n    \"stages_with_approval\": []\n}",
"policy": {"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
}
],
"entity": "7bbca5d4-e9f2-4955-9b2a-019ec4d3645e",
"entity_metadata": "7bbca5d4-e9f2-4955-9b2a-019ec4d3645e",
"id": 123,
"input": "",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline,service"
}
}

List data

List all stored data for a workspace.

Securityx-api-key

Request

path Parameters

org required	string [ 1 .. 128 ] characters Org is the organisation identifier. Example: k
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: ox
workspace required	string Workspace identifier Example: Optio voluptatem quia repudiandae dolore est.

query Parameters

pipeline_execution_id	string Filter by pipeline execution ID Example: pipeline_execution_id=Quia aperiam eligendi doloribus repellat.
pipeline_stage_id	string Filter by pipeline execution stage ID Example: pipeline_stage_id=Modi nesciunt modi labore perferendis harum.
provisioner_type	string Filter by provisioner type Example: provisioner_type=Ea incidunt a illum voluptatem et.
data_type	string Filter by data type Example: data_type=Et nemo nisi minima labore.
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

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: t

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}/workspaces/{workspace}/data

Request samples

curl
Java
Go

Response samples

application/json

[{"account": "p",
"created": 6340586930590025000,
"data_type": "cost_diff",
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"org": "8ix",
"pipeline_execution_id": "Blanditiis quaerat autem doloremque minus consequatur.",
"pipeline_id": "Vero rerum et.",
"pipeline_stage_id": "Autem suscipit beatae quibusdam soluta voluptatem earum.",
"project": "gc",
"provisioner_type": "tf",
"stage_id": "Assumenda consequatur id.",
"workspace": "workspace123"
},
{"account": "p",
"created": 6340586930590025000,
"data_type": "cost_diff",
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"org": "8ix",
"pipeline_execution_id": "Blanditiis quaerat autem doloremque minus consequatur.",
"pipeline_id": "Vero rerum et.",
"pipeline_stage_id": "Autem suscipit beatae quibusdam soluta voluptatem earum.",
"project": "gc",
"provisioner_type": "tf",
"stage_id": "Assumenda consequatur id.",
"workspace": "workspace123"
},
{"account": "p",
"created": 6340586930590025000,
"data_type": "cost_diff",
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"org": "8ix",
"pipeline_execution_id": "Blanditiis quaerat autem doloremque minus consequatur.",
"pipeline_id": "Vero rerum et.",
"pipeline_stage_id": "Autem suscipit beatae quibusdam soluta voluptatem earum.",
"project": "gc",
"provisioner_type": "tf",
"stage_id": "Assumenda consequatur id.",
"workspace": "workspace123"
}
]

Create data

Store binary data generated by the provisioner, such as plans and state files.

Securityx-api-key

Request

path Parameters

org required	string [ 1 .. 128 ] characters Org is the organisation identifier. Example: nf2
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: 2bh
workspace required	string Workspace identifier Example: workspace123

query Parameters

pipeline_id required	string The unique identifier for the associated pipeline Example: pipeline_id=Voluptas dolores sed pariatur iure.
stage_id required	string The unique identifier for a stage Example: stage_id=Illo ullam iste.
pipeline_execution_id required	string The unique identifier for the associated pipeline execution Example: pipeline_execution_id=Ipsam labore qui omnis eos.
pipeline_stage_id required	string The unique identifier for the associated pipeline execution stage Example: pipeline_stage_id=Accusantium sint.
provisioner_type required	string Type of provisioner that created the data Value: "tf" Example: provisioner_type=tf
data_type required	string Type of data stored Enum: "plan_human" "state_raw" "state_human" "cost_breakdown" "cost_diff" "modules" "providers" Example: data_type=cost_diff
policy_action	string Policy action used during OPA evaluation Example: policy_action=afterTerraformApply

header Parameters

Harness-Account required	string [ 1 .. 128 ] characters Account is the internal customer account ID. Example: zrl
Content-Length	integer <int64> Size in bytes of the data. Example: 3750159260830129000

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}/workspaces/{workspace}/data

Request samples

curl
Java
Go

Response samples

application/json

{"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"policy_evaluation": [{"message": "Consequatur et assumenda explicabo.",
"policy_id": "Rerum cumque et dicta.",
"policy_name": "Saepe labore.",
"policy_set_id": "Soluta minima quaerat harum sit quia.",
"policy_set_name": "Corporis saepe ad non error.",
"policy_status": "Assumenda deserunt."
},
{"message": "Consequatur et assumenda explicabo.",
"policy_id": "Rerum cumque et dicta.",
"policy_name": "Saepe labore.",
"policy_set_id": "Soluta minima quaerat harum sit quia.",
"policy_set_name": "Corporis saepe ad non error.",
"policy_status": "Assumenda deserunt."
}
],
"policy_evaluation_message": "- instance type 'xlarge' is not permitted",
"policy_evaluation_status": "error"
}

Show data

Get binary data generated by the provisioner, such as plans and state files.

Securityx-api-key

Request

path Parameters

org required	string [ 1 .. 128 ] characters Org is the organisation identifier. Example: 60p
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: v
workspace required	string Workspace is the resource workspace this variable is associated with. Example: Id repellat distinctio.
id required	string The unique identifier for the data Example: dc538c61-de48-4220-958c-5f3c4f983daa

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: f

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}/workspaces/{workspace}/data/{id}

Request samples

curl
Java
Go

Response samples

application/json

"string"

Evaluate data

Evaluate policy against previously stored data, such as plans and state files.

Securityx-api-key

Request

path Parameters

org required	string [ 1 .. 128 ] characters Org is the organisation identifier. Example: l17
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: wx4
workspace required	string Workspace is the resource workspace this variable is associated with. Example: Perspiciatis veritatis totam deleniti.
id required	string The unique identifier for the data Example: dc538c61-de48-4220-958c-5f3c4f983daa

query Parameters

pipeline_execution_id	string Pipeline execution associated with this evaluation Example: pipeline_execution_id=Rerum sapiente veniam aspernatur ex.
policy_action required	string Policy action used during OPA evaluation Example: policy_action=afterTerraformApply

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: yt

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}/workspaces/{workspace}/data/{id}/evaluate-policy

Request samples

curl
Java
Go

Response samples

application/json

{"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"policy_evaluation": [{"message": "Consequatur et assumenda explicabo.",
"policy_id": "Rerum cumque et dicta.",
"policy_name": "Saepe labore.",
"policy_set_id": "Soluta minima quaerat harum sit quia.",
"policy_set_name": "Corporis saepe ad non error.",
"policy_status": "Assumenda deserunt."
},
{"message": "Consequatur et assumenda explicabo.",
"policy_id": "Rerum cumque et dicta.",
"policy_name": "Saepe labore.",
"policy_set_id": "Soluta minima quaerat harum sit quia.",
"policy_set_name": "Corporis saepe ad non error.",
"policy_status": "Assumenda deserunt."
},
{"message": "Consequatur et assumenda explicabo.",
"policy_id": "Rerum cumque et dicta.",
"policy_name": "Saepe labore.",
"policy_set_id": "Soluta minima quaerat harum sit quia.",
"policy_set_name": "Corporis saepe ad non error.",
"policy_status": "Assumenda deserunt."
},
{"message": "Consequatur et assumenda explicabo.",
"policy_id": "Rerum cumque et dicta.",
"policy_name": "Saepe labore.",
"policy_set_id": "Soluta minima quaerat harum sit quia.",
"policy_set_name": "Corporis saepe ad non error.",
"policy_status": "Assumenda deserunt."
}
],
"policy_evaluation_message": "- instance type 'xlarge' is not permitted",
"policy_evaluation_status": "error"
}

Send event

Store binary data generated by the provisioner, such as plans and state files.

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: sb
workspace required	string [ 1 .. 1024 ] characters Workspace associated with this event Example: 0yf

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: n

Request Body schema: application/json
required

	object
event_type required	string The type of event that occurred Enum: "plan" "drifted" "provisioning" "destroying" "active" "inactive" "apply_needed" "failed" "stage-complete"
	object (ActivityMetadata)
pipeline_execution_id	string Default: "" Deprecated: use metadata instead
pipeline_stage_id	string Default: "" Deprecated: use metadata instead

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}/workspaces/{workspace}/events

Request samples

Payload
curl
Java
Go

application/json

{"data": {"Id ut sapiente.": "Vel quas cum reiciendis magni ad.",
"Officiis perspiciatis et est.": "Ea autem odit.",
"Vel et.": "Veniam rem temporibus consequatur est et."
},
"event_type": "active",
"metadata": {"PlannedChangesCount": 1364917683552446500,
"activity_status": "failure",
"activity_type": "apply",
"cost_breakdown_uuid": "Velit possimus fugit.",
"cost_currency": "Ut voluptatum atque suscipit magnam.",
"cost_diff_total_monthly": "Voluptatibus exercitationem cumque mollitia laborum dolores.",
"cost_diff_uuid": "Sequi dolores rerum.",
"cost_past_total_monthly": "Aut omnis id id ad ipsum tempore.",
"cost_total_monthly": "Possimus quibusdam dolores qui.",
"cost_total_monthly_percentage_change": "Ipsa eos.",
"drift_counts": {"added": 8350471850651856000,
"changed": 2019825285988501500,
"deleted": 2387447099578710000,
"unchanged": 1034729446304568800
},
"enable_solutions_factory": false,
"git_branch": "Esse quia repudiandae magnam.",
"git_commit_message": "Voluptatum est dolorem est omnis.",
"git_commit_sha": "Vel magnam.",
"git_repo": "Reiciendis nam inventore accusantium sequi nihil.",
"modules_uuid": "Porro sapiente rerum vero fugit.",
"output_counts": {"added": 8350471850651856000,
"changed": 2019825285988501500,
"deleted": 2387447099578710000,
"unchanged": 1034729446304568800
},
"pipeline": "Ducimus ab commodi eum voluptate.",
"pipeline_execution_id": "Magni aut amet corporis a tempora.",
"pipeline_execution_number": "Illo perspiciatis.",
"pipeline_name": "Consequatur quis mollitia et atque.",
"pipeline_stage_id": "In asperiores id saepe.",
"plan_uuid": "Voluptatem nulla perspiciatis officia quia natus impedit.",
"providers_uuid": "Velit voluptatem dolores id non.",
"provisioner": "Sint et sapiente qui dolores ipsa natus.",
"provisioner_version": "Veniam ratione molestiae qui eveniet est.",
"resource_counts": {"added": 8350471850651856000,
"changed": 2019825285988501500,
"deleted": 2387447099578710000,
"unchanged": 1034729446304568800
},
"state_checksum": "Molestiae nisi sint.",
"state_uuid": "Eum unde.",
"trigger": {"Ut suscipit laborum.": "Aperiam voluptatem et culpa."
}
},
"pipeline_execution_id": "Officiis ratione debitis placeat et placeat consectetur.",
"pipeline_stage_id": "Unde aspernatur omnis nobis ut."
}

List pipelines

List the pipelines where the workspace is been used

Securityx-api-key

Request

path Parameters

org required	string [ 1 .. 128 ] characters Org is the organisation identifier. Example: 7x
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: oh
workspace required	string Workspace identifier Example: Omnis dolores quasi repudiandae voluptas.

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

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: v

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}/workspaces/{workspace}/pipelines

Request samples

curl
Java
Go

Response samples

application/json

{"account": "w",
"org": "u",
"pipelines": ["Eum consequuntur corrupti quaerat et non.",
"Sed natus qui aliquid excepturi aut.",
"Et dolor."
],
"project": "7o8"
}

Create remote execution

Create a remote execution for a workspace.

Securityx-api-key

Request

path Parameters

org required	string [ 1 .. 128 ] characters Org is the organisation identifier. Example: yi5
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: ap4
workspace required	string The workspace associated with the remote execution. Example: Ducimus non eius repudiandae aspernatur at.

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: 5ci

Request Body schema: application/json
required

object

The arguments supplied to the plan.

Responses

201

Created 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}/workspaces/{workspace}/remote-executions

Request samples

Payload
curl
Java
Go

application/json

{"custom_arguments": {"Aut ab dolorem sint.": ["Quia et.",
"Sunt quae eveniet ullam quia.",
"Modi consequatur esse iusto aliquam perspiciatis.",
"Maiores fugiat eum."
],
"Aut odit quod.": ["Quidem tempora alias inventore.",
"Quia a."
]
}
}

Response samples

application/json

{"account": "g",
"created": 6796432605507689000,
"custom_arguments": {"Alias velit sed non excepturi eum.": ["Nisi voluptatem eius voluptas mollitia.",
"Ut inventore.",
"Asperiores quisquam.",
"Possimus quo."
],
"Maiores sint dignissimos et occaecati repellendus consequatur.": ["Soluta provident numquam blanditiis rem placeat.",
"Quia est.",
"Quas quo."
]
},
"executed": false,
"id": "f39564d8-bf68-416b-99a1-1d186fbd16df",
"org": "lp",
"pipeline_execution_id": "Minus sed rem id omnis quia.",
"pipeline_execution_url": "Dolor voluptatem assumenda placeat atque voluptas sint.",
"project": "c",
"sha256_checksum": "Veniam minus doloremque praesentium at.",
"updated": 5581283499865030000,
"workspace": "Illum aut labore iste consequatur."
}

Show remote execution

Find remote execution

Securityx-api-key

Request

path Parameters

org required	string [ 1 .. 128 ] characters Org is the organisation identifier. Example: v8j
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: 5j
workspace required	string Workspace is the resource workspace this variable is associated with. Example: Molestiae debitis minima.
id required	string <uuid> The ID of the remote execution Example: 47179f79-ce14-4e42-a0d5-2dde85cf88de

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: 82

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}/workspaces/{workspace}/remote-executions/{id}

Request samples

curl
Java
Go

Response samples

application/json

{"account": "q",
"created": 6895608169628662000,
"custom_arguments": {"Dolor sed illum nihil fuga quis.": ["Qui optio dolorum omnis nihil incidunt.",
"Accusamus ullam dolorum voluptatem veritatis.",
"Laborum atque nobis."
],
"Numquam quibusdam.": ["Aut perferendis quia voluptatum sit molestias.",
"Sunt a nam rerum impedit ullam.",
"Aut quia qui quia quam.",
"Aspernatur vero dolore."
],
"Quidem doloremque architecto quis alias sunt dolores.": ["Non ut nisi eius.",
"Doloremque reiciendis placeat eligendi beatae velit."
]
},
"executed": true,
"id": "054da9a2-89a7-4377-9f98-c778f0221f4b",
"org": "iq",
"pipeline_execution_id": "Cumque nihil numquam voluptas in sint.",
"pipeline_execution_url": "Molestias voluptas natus consequatur voluptatem itaque.",
"project": "ro",
"sha256_checksum": "Impedit non.",
"updated": 7736112453439941000,
"workspace": "Et hic odio quo dolore."
}

Download remote exectution

Download the source code for the remote plan.

Securityx-api-key

Request

path Parameters

org required	string [ 1 .. 128 ] characters Org is the organisation identifier. Example: pzl
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: 2
workspace required	string Workspace is the resource workspace this variable is associated with. Example: Voluptas repellendus dolorem repellat vero provident quam.
id required	string <uuid> The ID of the remote execution Example: a27a19fe-c0da-4126-a727-5f5907945cec

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: re

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}/workspaces/{workspace}/remote-executions/{id}/download

Request samples

curl
Java
Go

Response samples

application/json

"string"

execute-remote-execution workspaces

Execute the remote execution

Securityx-api-key

Request

path Parameters

org required	string [ 1 .. 128 ] characters Org is the organisation identifier. Example: x1x
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: oo4
workspace required	string Workspace is the resource workspace this variable is associated with. Example: Ipsum et molestiae.
id required	string <uuid> The ID of the remote execution Example: 99e019e4-01d9-4e40-bfc3-c4fd03e5c424

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: c

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}/workspaces/{workspace}/remote-executions/{id}/execute

Request samples

curl
Java
Go

Response samples

application/json

{"account": "vpx",
"created": 2830997456919589000,
"custom_arguments": {"Qui facilis dolor.": ["A accusantium tenetur consequuntur.",
"Nihil odit sequi sit vitae."
],
"Qui reprehenderit.": ["Omnis consectetur delectus delectus veritatis.",
"Dolores aut.",
"Ut ad aut praesentium maiores deserunt ipsum."
],
"Totam facilis autem aliquid occaecati quas fugit.": ["Qui repellendus id sit.",
"Ducimus voluptatibus."
]
},
"executed": false,
"id": "66b5d608-e7b0-4e25-8150-5fba06920276",
"org": "pg5",
"pipeline_execution_id": "Ipsa cum consequuntur.",
"pipeline_execution_url": "Qui dolor iste.",
"project": "t",
"sha256_checksum": "Vel labore aperiam repellat numquam vitae.",
"updated": 8431938297301139000,
"workspace": "Assumenda beatae enim numquam."
}

Upload remote execution source

Upload the source code for the remote execution.

Securityx-api-key

Request

path Parameters

org required	string [ 1 .. 128 ] characters Org is the organisation identifier. Example: uei
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: o
workspace required	string Workspace is the resource workspace this variable is associated with. Example: Aut fugiat corrupti.
id required	string <uuid> The ID of the remote execution Example: c695af7e-cc2d-45bf-b678-728d1379e1ef

header Parameters

Harness-Account required	string [ 1 .. 128 ] characters Account is the internal customer account ID. Example: j
Content-Length	integer <int64> Size in bytes of the source code. Example: 3157012724378926000
Content-Digest required	string Content-Digest header as defined in https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Digest. Sha256 is the only supported algorithm. Example: Quas voluptas.

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}/workspaces/{workspace}/remote-executions/{id}/upload

Request samples

curl
Java
Go

Response samples

application/json

{"account": "em",
"created": 8788675175155536000,
"custom_arguments": {"Enim minus voluptatem fuga.": ["Ducimus ea consectetur.",
"Voluptatem aut qui blanditiis facilis ut quae.",
"Officiis accusamus.",
"Qui earum libero minus eos."
],
"Molestias aliquid deleniti nesciunt.": ["Mollitia quasi dolore.",
"Qui quibusdam ut iure architecto."
],
"Quod repellat unde modi libero.": ["Id voluptas soluta aut enim.",
"Qui rerum.",
"Vel ut sint dolor non.",
"Voluptas sunt voluptatem ullam voluptas quod."
]
},
"executed": false,
"id": "0a0721aa-73f4-44d6-b15a-3fea02e90c09",
"org": "lq",
"pipeline_execution_id": "Sequi impedit velit.",
"pipeline_execution_url": "Ipsa quis repellat itaque recusandae.",
"project": "4",
"sha256_checksum": "Ipsam nihil eligendi omnis facere.",
"updated": 2429276041302306000,
"workspace": "Velit et ut a."
}

List provisioners ratio

Retrieves the ratio of provisioners used by workspaces

Securityx-api-key

Request

path Parameters

org required	string [ 1 .. 128 ] characters Org is the organisation identifier. Example: oeq
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: 8gz

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: ld

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}/workspaces/provisioners-ratio

Request samples

curl
Java
Go

Response samples

application/json

{"provisioner": {"Aspernatur dicta veniam consequatur quis.": 0.500037716653363,
"Ratione nemo.": 0.34103339568918145,
"Vel suscipit et qui.": 0.012939227066625803
},
"total": 0.5232939552860555
}

List workspaces associated with a template ID

Get all workspaces associated with a specific template ID

Securityx-api-key

Request

path Parameters

template_id

required

string [ 1 .. 128 ] characters

Template identifier to filter workspaces

Example: fcx

query Parameters

org	string [ 1 .. 128 ] characters Organization identifier (required for 'org' and 'project' scope). Example: org=jr
project	string [ 1 .. 128 ] characters Project identifier (required for 'project' scope). Example: project=nl
version	string [ 1 .. 32 ] characters Template version associated with the workspace. Example: version=o

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account identifier.

Example: y

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/workspace/templates/{template_id}

Request samples

curl
Java
Go

Response samples

application/json

[{"account": "dj",
"created_at": 1627590400,
"org": "rg",
"project": "ju",
"template_id": "i4",
"updated_at": 1627686800,
"version": "vy",
"workspace_id": "e"
},
{"account": "dj",
"created_at": 1627590400,
"org": "rg",
"project": "ju",
"template_id": "i4",
"updated_at": 1627686800,
"version": "vy",
"workspace_id": "e"
}
]

➔ Next to settings

workspaces

List all workspace tags

path Parameters

header Parameters

Show workspace metrics

path Parameters

header Parameters

List workspaces

path Parameters

query Parameters

header Parameters

Create workspace

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Destroy workspace

path Parameters

header Parameters

Show workspace

path Parameters

header Parameters

Update workspace

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Force unlock workspace

path Parameters

header Parameters

List modules

path Parameters

header Parameters

List resources

path Parameters

header Parameters

Clone workspace

path Parameters

header Parameters

Request Body schema: application/jsonrequired

List data

path Parameters

query Parameters

header Parameters

Create data

path Parameters

query Parameters

header Parameters

Show data

path Parameters

header Parameters

Evaluate data

path Parameters

query Parameters

header Parameters

Send event

path Parameters

header Parameters

Request Body schema: application/jsonrequired

List pipelines

path Parameters

query Parameters

header Parameters

Create remote execution

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Show remote execution

path Parameters

header Parameters

Download remote exectution

path Parameters

header Parameters

execute-remote-execution workspaces

path Parameters

header Parameters

Upload remote execution source

path Parameters

header Parameters

List provisioners ratio

path Parameters

header Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required