workspaces

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

List workspaces

List all workspaces.

Securityx-api-key

Request

path Parameters

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

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=updated,ASC
status	Array of strings Status of the execution Example: status=At dolorum ea quaerat ut adipisci incidunt.&status=Sint reiciendis exercitationem doloremque natus.&status=Blanditiis beatae voluptatem non dolore.

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: tys

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": "k4",
"created": 2169628125943076900,
"description": "this is a more detailed explanation of the resource.",
"identifier": "bl",
"name": "resource name",
"org": "r",
"project": "26",
"status": "unknown",
"updated": 3455569662986103000
},
{"account": "k4",
"created": 2169628125943076900,
"description": "this is a more detailed explanation of the resource.",
"identifier": "bl",
"name": "resource name",
"org": "r",
"project": "26",
"status": "unknown",
"updated": 3455569662986103000
}
]

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: hm

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: 6fn

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.
state_checksum	string state_checksum is the sha-256 checksum of terraform state file
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.

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": "g",
"version": "ft"
},
"budget": 0.4625265,
"cost_breakdown_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"cost_diff_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"cost_estimation_enabled": true,
"default_pipelines": {"Architecto delectus repellendus quia.": {"project_pipeline": "Consequatur deserunt neque.",
"workspace_pipeline": "Numquam vitae eum tempore illo saepe voluptas."
}
},
"description": "this is a more detailed explanation of the resource.",
"environment_variables": {"Doloribus praesentium fugit.": {"key": "r",
"value": "Aut reiciendis nemo cupiditate atque id.",
"value_type": "secret"
},
"Necessitatibus est aperiam sed quia.": {"key": "r",
"value": "Aut reiciendis nemo cupiditate atque id.",
"value_type": "secret"
},
"Repellat qui molestiae autem voluptatum et quos.": {"key": "r",
"value": "Aut reiciendis nemo cupiditate atque id.",
"value_type": "secret"
}
},
"identifier": "pj",
"modules_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"name": "resource name",
"provider_connector": "Sit sit necessitatibus explicabo incidunt.",
"providers_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"provisioner": "opentofu",
"provisioner_version": "Exercitationem quam beatae amet consequatur.",
"repository": "Doloremque quos.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Voluptatem vel.",
"repository_path": "",
"repository_sha": "abc10ed",
"state_checksum": "d21c1662d8ce2c74f24efdc8db93eb34473b86810aeccca4b1518f70b0ccde8f",
"terraform_plan_json": "f9e21473daaa2674d862b67a1339f4570e86de17",
"terraform_state": "fc1200c7a7aa52109d762a9f005b149abef01479",
"terraform_state_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"terraform_variable_files": [{"repository": "Eaque non.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Provident laborum alias voluptas voluptatem dolorem.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{"repository": "Eaque non.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Provident laborum alias voluptas voluptatem dolorem.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{"repository": "Eaque non.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Provident laborum alias voluptas voluptatem dolorem.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{"repository": "Eaque non.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Provident laborum alias voluptas voluptatem dolorem.",
"repository_path": "",
"repository_sha": "abc10ed"
}
],
"terraform_variables": {"Earum maxime ullam iusto ipsa.": {"key": "r",
"value": "Aut reiciendis nemo cupiditate atque id.",
"value_type": "secret"
},
"Incidunt quis qui perferendis voluptatem est quasi.": {"key": "r",
"value": "Aut reiciendis nemo cupiditate atque id.",
"value_type": "secret"
},
"Natus dignissimos repellat tempora sit id illum.": {"key": "r",
"value": "Aut reiciendis nemo cupiditate atque id.",
"value_type": "secret"
}
}
}

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

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: a

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

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

Request samples

curl
Java
Go

Response samples

application/json

{"account": "e",
"associated_template": {"template_id": "zjz",
"version": "1t"
},
"backend_locked": true,
"budget": 0.46742985,
"cost_breakdown_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"cost_diff_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"cost_estimation_enabled": true,
"created": 15606262374513792,
"default_pipelines": {"In ut nihil reiciendis fuga sed vel.": {"project_pipeline": "Voluptatum aut doloribus.",
"workspace_pipeline": "Quasi dolores iure fuga."
},
"Laudantium aliquam.": {"project_pipeline": "Voluptatum aut doloribus.",
"workspace_pipeline": "Quasi dolores iure fuga."
},
"Minus eaque dolor necessitatibus rerum iusto totam.": {"project_pipeline": "Voluptatum aut doloribus.",
"workspace_pipeline": "Quasi dolores iure fuga."
}
},
"description": "this is a more detailed explanation of the resource.",
"environment_variables": {"Error laborum perferendis saepe.": {"created": 3479859128708816400,
"key": "h",
"updated": 6209509391613439000,
"value": "Deserunt maiores id neque.",
"value_type": "secret"
},
"Sapiente error reiciendis unde.": {"created": 3479859128708816400,
"key": "h",
"updated": 6209509391613439000,
"value": "Deserunt maiores id neque.",
"value_type": "secret"
},
"Soluta nisi odio consequatur et ad.": {"created": 3479859128708816400,
"key": "h",
"updated": 6209509391613439000,
"value": "Deserunt maiores id neque.",
"value_type": "secret"
}
},
"identifier": "8",
"modules_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"name": "resource name",
"org": "7si",
"project": "56",
"provider_connector": "Voluptatibus ullam aut iusto.",
"providers_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"provisioner": "opentofu",
"provisioner_data": "Facere cupiditate.",
"provisioner_version": "Temporibus autem voluptatibus eveniet.",
"repository": "Nihil rerum debitis vel iure adipisci similique.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Rem reiciendis aliquam doloremque ea quasi a.",
"repository_path": "",
"repository_sha": "abc10ed",
"state_checksum": "d21c1662d8ce2c74f24efdc8db93eb34473b86810aeccca4b1518f70b0ccde8f",
"status": "provisioning",
"terraform_plan_json": "f9e21473daaa2674d862b67a1339f4570e86de17",
"terraform_state": "fc1200c7a7aa52109d762a9f005b149abef01479",
"terraform_state_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"terraform_variable_files": [{"repository": "Fugit perferendis asperiores architecto a quidem debitis.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Consequatur et ipsa reprehenderit dolorem sit.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{"repository": "Fugit perferendis asperiores architecto a quidem debitis.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Consequatur et ipsa reprehenderit dolorem sit.",
"repository_path": "",
"repository_sha": "abc10ed"
}
],
"terraform_variables": {"Corrupti voluptatem aliquam est nobis.": {"created": 3479859128708816400,
"key": "h",
"updated": 6209509391613439000,
"value": "Deserunt maiores id neque.",
"value_type": "secret"
},
"Id deleniti quae qui quisquam cupiditate.": {"created": 3479859128708816400,
"key": "h",
"updated": 6209509391613439000,
"value": "Deserunt maiores id neque.",
"value_type": "secret"
}
},
"updated": 7648283165021074000
}

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: n6g
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: ky
identifier required	string [ 1 .. 128 ] characters Workspace identifier. Example: a

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: uku

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

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.93920505,
"cost_estimation_enabled": true,
"default_pipelines": {"Debitis rerum.": {"project_pipeline": "Consequatur deserunt neque.",
"workspace_pipeline": "Numquam vitae eum tempore illo saepe voluptas."
},
"Ullam consequatur repellat ut qui.": {"project_pipeline": "Consequatur deserunt neque.",
"workspace_pipeline": "Numquam vitae eum tempore illo saepe voluptas."
}
},
"description": "this is a more detailed explanation of the resource.",
"environment_variables": {"Eaque esse rerum et.": {"key": "r",
"value": "Aut reiciendis nemo cupiditate atque id.",
"value_type": "secret"
}
},
"name": "resource name",
"provider_connector": "Sed in qui amet.",
"provisioner": "opentofu",
"provisioner_version": "Quia possimus consequatur.",
"repository": "Rerum molestias error excepturi laudantium dignissimos.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "At deserunt.",
"repository_path": "",
"repository_sha": "abc10ed",
"terraform_variable_files": [{"repository": "Eaque non.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Provident laborum alias voluptas voluptatem dolorem.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{"repository": "Eaque non.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Provident laborum alias voluptas voluptatem dolorem.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{"repository": "Eaque non.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Provident laborum alias voluptas voluptatem dolorem.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{"repository": "Eaque non.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Provident laborum alias voluptas voluptatem dolorem.",
"repository_path": "",
"repository_sha": "abc10ed"
}
],
"terraform_variables": {"Illum labore dolorum ab dignissimos aut consequatur.": {"key": "r",
"value": "Aut reiciendis nemo cupiditate atque id.",
"value_type": "secret"
},
"Provident quis fugit fugiat perspiciatis optio nemo.": {"key": "r",
"value": "Aut reiciendis nemo cupiditate atque id.",
"value_type": "secret"
},
"Tempore ullam dolor dolor eligendi fugiat.": {"key": "r",
"value": "Aut reiciendis nemo cupiditate atque id.",
"value_type": "secret"
}
}
}

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

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: q8

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: na
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: r17
identifier required	string [ 1 .. 128 ] characters Identifier is the project identifier. Example: v

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: tf

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"
}
]

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: 36r
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: a5h
identifier required	string [ 1 .. 128 ] characters Identifier is the project identifier. Example: f

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: a9

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": "Quibusdam quisquam."
},
{"name": "instance_public_ip",
"sensitive": true,
"value": "Quibusdam quisquam."
},
{"name": "instance_public_ip",
"sensitive": true,
"value": "Quibusdam quisquam."
},
{"name": "instance_public_ip",
"sensitive": true,
"value": "Quibusdam quisquam."
}
],
"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: x1o
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: u1m
workspace required	string Example: Vitae quas quam laudantium dolor odio officia.

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: s

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": "ys",
"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: w8
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: 4c3
workspace required	string Workspace identifier Example: Optio accusamus.

query Parameters

pipeline_execution_id	string Filter by pipeline execution ID Example: pipeline_execution_id=Molestias reprehenderit qui quas.
pipeline_stage_id	string Filter by pipeline execution stage ID Example: pipeline_stage_id=Qui odit molestiae est.
provisioner_type	string Filter by provisioner type Example: provisioner_type=Minus temporibus accusamus.
data_type	string Filter by data type Example: data_type=Et incidunt modi voluptatibus voluptatem quis quas.
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: x4

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": "u",
"created": 6874645815520171000,
"data_type": "state_raw",
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"org": "5kc",
"pipeline_execution_id": "Aspernatur sunt modi saepe voluptates quia.",
"pipeline_id": "Quisquam sint debitis sequi repellendus iure.",
"pipeline_stage_id": "Aut molestiae maiores repellat tenetur hic.",
"project": "d",
"provisioner_type": "tf",
"stage_id": "Impedit itaque neque quidem necessitatibus.",
"workspace": "workspace123"
},
{"account": "u",
"created": 6874645815520171000,
"data_type": "state_raw",
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"org": "5kc",
"pipeline_execution_id": "Aspernatur sunt modi saepe voluptates quia.",
"pipeline_id": "Quisquam sint debitis sequi repellendus iure.",
"pipeline_stage_id": "Aut molestiae maiores repellat tenetur hic.",
"project": "d",
"provisioner_type": "tf",
"stage_id": "Impedit itaque neque quidem necessitatibus.",
"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: r
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: sk5
workspace required	string Workspace identifier Example: workspace123

query Parameters

pipeline_id required	string The unique identifier for the associated pipeline Example: pipeline_id=Maiores dolor totam.
stage_id required	string The unique identifier for a stage Example: stage_id=Eum a illum autem molestias.
pipeline_execution_id required	string The unique identifier for the associated pipeline execution Example: pipeline_execution_id=Inventore ea voluptas fugiat nulla eum.
pipeline_stage_id required	string The unique identifier for the associated pipeline execution stage Example: pipeline_stage_id=Et quis unde ut et nostrum aut.
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=providers
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: gq

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": "Non et id porro consequuntur.",
"policy_id": "Quis voluptatibus minus molestiae enim animi.",
"policy_name": "Et est corrupti suscipit.",
"policy_set_id": "Sint ea reprehenderit non vel non.",
"policy_set_name": "Non et quia velit natus.",
"policy_status": "Inventore aut est est rerum ut illum."
},
{"message": "Non et id porro consequuntur.",
"policy_id": "Quis voluptatibus minus molestiae enim animi.",
"policy_name": "Et est corrupti suscipit.",
"policy_set_id": "Sint ea reprehenderit non vel non.",
"policy_set_name": "Non et quia velit natus.",
"policy_status": "Inventore aut est est rerum ut illum."
},
{"message": "Non et id porro consequuntur.",
"policy_id": "Quis voluptatibus minus molestiae enim animi.",
"policy_name": "Et est corrupti suscipit.",
"policy_set_id": "Sint ea reprehenderit non vel non.",
"policy_set_name": "Non et quia velit natus.",
"policy_status": "Inventore aut est est rerum ut illum."
}
],
"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: 0ka
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: 95
workspace required	string Workspace is the resource workspace this variable is associated with. Example: Ratione odio laudantium et.
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: 0ts

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: ko
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: t0y
workspace required	string Workspace is the resource workspace this variable is associated with. Example: Et esse.
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=Animi nihil voluptatem ipsum non dolor.
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: uk

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": "Non et id porro consequuntur.",
"policy_id": "Quis voluptatibus minus molestiae enim animi.",
"policy_name": "Et est corrupti suscipit.",
"policy_set_id": "Sint ea reprehenderit non vel non.",
"policy_set_name": "Non et quia velit natus.",
"policy_status": "Inventore aut est est rerum ut illum."
},
{"message": "Non et id porro consequuntur.",
"policy_id": "Quis voluptatibus minus molestiae enim animi.",
"policy_name": "Et est corrupti suscipit.",
"policy_set_id": "Sint ea reprehenderit non vel non.",
"policy_set_name": "Non et quia velit natus.",
"policy_status": "Inventore aut est est rerum ut illum."
}
],
"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: pk
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: 0
workspace required	string [ 1 .. 1024 ] characters Workspace associated with this event Example: 1ir

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: 1h

Request Body schema: application/json
required

	object
event_type required	string The type of event that occurred Enum: "plan" "drifted" "provisioning" "destroying" "active" "inactive" "failed"
	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": {"Ad illo ut et quisquam odio.": "Consectetur non rem aperiam dolores consequuntur.",
"Nesciunt tempore facilis illum et.": "Tempora commodi eius vero fugiat quod."
},
"event_type": "provisioning",
"metadata": {"PlannedChangesCount": 33440872303079776,
"activity_status": "success",
"activity_type": "drifted",
"cost_breakdown_uuid": "Eius ut dolor exercitationem officiis ut dignissimos.",
"cost_currency": "Quia ut sint unde.",
"cost_diff_total_monthly": "Commodi esse cum nemo laboriosam consequatur nobis.",
"cost_diff_uuid": "Ratione rerum numquam ut.",
"cost_past_total_monthly": "Quae qui eveniet sunt quam nobis.",
"cost_total_monthly": "Quod corrupti.",
"cost_total_monthly_percentage_change": "Rerum sed.",
"drift_counts": {"added": 6016884482012127000,
"changed": 4517292233083266600,
"deleted": 6093227837463932000,
"unchanged": 3882433982357368300
},
"enable_solutions_factory": false,
"git_branch": "Sit minima voluptas ipsum ut quasi reiciendis.",
"git_commit_message": "Et et sapiente eum at.",
"git_commit_sha": "Molestiae commodi.",
"modules_uuid": "Distinctio vero eos sequi.",
"output_counts": {"added": 6016884482012127000,
"changed": 4517292233083266600,
"deleted": 6093227837463932000,
"unchanged": 3882433982357368300
},
"pipeline": "Fugit corrupti suscipit consequuntur officiis error repellat.",
"pipeline_execution_id": "Laboriosam adipisci.",
"pipeline_execution_number": "Cupiditate repudiandae totam.",
"pipeline_name": "Nesciunt autem ipsum eos commodi.",
"pipeline_stage_id": "Fugit laborum laboriosam maiores error porro hic.",
"plan_uuid": "Occaecati soluta deleniti nostrum.",
"providers_uuid": "Praesentium laborum fugiat modi tenetur.",
"provisioner": "In illo quis nihil commodi.",
"provisioner_version": "Quo veritatis ea omnis sed nemo.",
"resource_counts": {"added": 6016884482012127000,
"changed": 4517292233083266600,
"deleted": 6093227837463932000,
"unchanged": 3882433982357368300
},
"state_checksum": "Deserunt qui.",
"state_uuid": "Et et praesentium.",
"trigger": {"Assumenda quia ipsum illo tenetur expedita est.": "Nisi laboriosam reprehenderit.",
"Magnam earum fugit qui laboriosam aut voluptates.": "Illo autem eveniet.",
"Temporibus ipsum deleniti.": "Nostrum sequi voluptas deleniti velit."
}
},
"pipeline_execution_id": "Consequatur nisi nobis.",
"pipeline_stage_id": "Id quis laboriosam porro."
}

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: hr
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: 0t
workspace required	string Workspace identifier Example: Consequatur officiis quos atque ex molestiae.

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: v0

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": "b1x",
"org": "w",
"pipelines": ["Deserunt aut.",
"Cum ratione eum."
],
"project": "c"
}

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: z
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: 4y
workspace required	string The workspace associated with the remote execution. Example: Repudiandae minus.

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: oh0

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

curl
Java
Go

Response samples

application/json

{"account": "su",
"created": 6195900757677003000,
"executed": false,
"id": "7ccc4ca3-d4e3-4f6d-b904-1025996d110c",
"org": "28",
"pipeline_execution_id": "Ut et.",
"pipeline_execution_url": "Et quia molestiae et.",
"project": "yp",
"sha256_checksum": "Magni qui eius voluptas dolorem voluptatem et.",
"updated": 3554276483322120000,
"workspace": "Unde quis dolorem."
}

Show remote execution

Find remote execution

Securityx-api-key

Request

path Parameters

org required	string [ 1 .. 128 ] characters Org is the organisation identifier. Example: b8
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: tu
workspace required	string Workspace is the resource workspace this variable is associated with. Example: Ipsam voluptatem aperiam ratione adipisci qui facilis.
id required	string <uuid> The ID of the remote execution Example: ee34cbb2-1820-4102-90f9-c29600b1a2ab

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: l

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": "cu",
"created": 3913651902901968000,
"executed": false,
"id": "76356790-535b-4f50-aa0f-5a3486d6ad83",
"org": "ubn",
"pipeline_execution_id": "Exercitationem dolorem modi est quisquam.",
"pipeline_execution_url": "Nobis similique eius minus qui et repellendus.",
"project": "vl",
"sha256_checksum": "Odit nulla occaecati aut est praesentium.",
"updated": 398420087263650100,
"workspace": "Quaerat vel asperiores doloremque totam eos."
}

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: mvm
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: ou
workspace required	string Workspace is the resource workspace this variable is associated with. Example: Ex consectetur laboriosam et adipisci ullam est.
id required	string <uuid> The ID of the remote execution Example: 36f0a9b4-17bc-4037-b17d-f6df7dc02abd

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/{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: v
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: Eos quo magnam dignissimos aperiam.
id required	string <uuid> The ID of the remote execution Example: abb17de5-7911-4825-a3a8-8e52813e57dd

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: 9

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": "91s",
"created": 9053115257904278000,
"executed": false,
"id": "b35c0a67-c275-43d1-b357-4af94155ff71",
"org": "7",
"pipeline_execution_id": "Reiciendis eos nihil alias eligendi eos quos.",
"pipeline_execution_url": "Accusantium voluptas beatae.",
"project": "ee",
"sha256_checksum": "Dignissimos numquam voluptate.",
"updated": 5339652572553813000,
"workspace": "Ea laborum omnis."
}

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: v4
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: no
workspace required	string Workspace is the resource workspace this variable is associated with. Example: Officiis corporis deleniti sit quasi et fugit.
id required	string <uuid> The ID of the remote execution Example: 44433c2a-9ae2-4ae6-86a5-38095f3e4a42

header Parameters

Harness-Account required	string [ 1 .. 128 ] characters Account is the internal customer account ID. Example: xw2
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: Dolor consequuntur.

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": "gnr",
"created": 4236378766778710500,
"executed": true,
"id": "39c1f616-60c1-492b-8642-aa17e319fa08",
"org": "859",
"pipeline_execution_id": "Non aspernatur.",
"pipeline_execution_url": "Esse ratione vero.",
"project": "pw",
"sha256_checksum": "Nesciunt architecto tenetur minus accusamus iure.",
"updated": 1601075547748822000,
"workspace": "Eaque et quasi sapiente nostrum rerum."
}

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: qcz

query Parameters

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

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account identifier.

Example: 3

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": "z",
"created_at": 1627590400,
"org": "88c",
"project": "tm",
"template_id": "h",
"updated_at": 1627686800,
"version": "h3",
"workspace_id": "62"
},
{"account": "z",
"created_at": 1627590400,
"org": "88c",
"project": "tm",
"template_id": "h",
"updated_at": 1627686800,
"version": "h3",
"workspace_id": "62"
},
{"account": "z",
"created_at": 1627590400,
"org": "88c",
"project": "tm",
"template_id": "h",
"updated_at": 1627686800,
"version": "h3",
"workspace_id": "62"
},
{"account": "z",
"created_at": 1627590400,
"org": "88c",
"project": "tm",
"template_id": "h",
"updated_at": 1627686800,
"version": "h3",
"workspace_id": "62"
}
]

➔ Next to settings

workspaces

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

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 workspaces associated with a template ID

path Parameters

query 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