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

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: n

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

["Accusantium alias sit error.",
"Quo est expedita necessitatibus tempora.",
"Autem maiores.",
"Non porro nesciunt voluptatem."
]

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

query Parameters

start_time	integer <int64> Start time filter (Unix timestamp) Example: start_time=5315617798595896000
end_time	integer <int64> End time filter (Unix timestamp) Example: end_time=8581516743480713000

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: szx

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": {"Dolores natus.": 3071406004755095000
}
}

List workspaces

List all workspaces.

Securityx-api-key

Request

path Parameters

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

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,DESC
status	Array of strings Status of the execution Example: status=Et et.&status=Est occaecati quas rerum illum porro iusto.&status=Accusantium fuga tempora.&status=Ipsam error cupiditate numquam libero tenetur.
tags	Array of strings Comma separated list of tags to filter by Example: tags=Possimus ut perferendis.&tags=Officiis esse fugiat rerum ut porro.

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: p

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": "q",
"created": 1208790653448628500,
"description": "this is a more detailed explanation of the resource.",
"identifier": "s1v",
"name": "resource name",
"org": "g",
"project": "0a",
"status": "unknown",
"updated": 2786574127142621000
},
{"account": "q",
"created": 1208790653448628500,
"description": "this is a more detailed explanation of the resource.",
"identifier": "s1v",
"name": "resource name",
"org": "g",
"project": "0a",
"status": "unknown",
"updated": 2786574127142621000
},
{"account": "q",
"created": 1208790653448628500,
"description": "this is a more detailed explanation of the resource.",
"identifier": "s1v",
"name": "resource name",
"org": "g",
"project": "0a",
"status": "unknown",
"updated": 2786574127142621000
}
]

Create workspace

Create a new workspace.

Securityx-api-key

Request

path Parameters

org required	string [ 1 .. 128 ] characters Org is the organisation identifier. Example: pdz
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: nu

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.
id	integer <int64> ID PK for internal uses
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.
	Array of objects (WorkspaceProviderConnector) define an array of provider connectors that belong to Workspace
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": "7u",
"version": "4u"
},
"budget": 0.96011406,
"cost_breakdown_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"cost_diff_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"cost_estimation_enabled": true,
"default_pipelines": {"Asperiores facere est quia.": {"project_pipeline": "Optio quos sunt magni reiciendis.",
"workspace_pipeline": "Aperiam ipsum aperiam quis."
}
},
"description": "this is a more detailed explanation of the resource.",
"environment_variables": {"Id non.": {"key": "i5",
"value": "Rerum cumque.",
"value_type": "secret"
},
"Molestiae nisi sint.": {"key": "i5",
"value": "Rerum cumque.",
"value_type": "secret"
},
"Vero fugit in velit voluptatem.": {"key": "i5",
"value": "Rerum cumque.",
"value_type": "secret"
}
},
"id": 7066108598060831000,
"identifier": "i",
"modules_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"name": "resource name",
"provider_connector": "Aut omnis id id ad ipsum tempore.",
"provider_connectors": [{"connector_ref": "h8h",
"created": 1627590400,
"id": 3972048360848832500,
"type": "gcp",
"updated": 1627686800,
"workspace_id": 7356608592720691000
},
{"connector_ref": "h8h",
"created": 1627590400,
"id": 3972048360848832500,
"type": "gcp",
"updated": 1627686800,
"workspace_id": 7356608592720691000
}
],
"providers_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"provisioner": "opentofu",
"provisioner_version": "Possimus quibusdam dolores qui.",
"repository": "Voluptatibus exercitationem cumque mollitia laborum dolores.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Ipsa eos.",
"repository_path": "",
"repository_sha": "abc10ed",
"repository_submodules": "recursive",
"sparse_checkout": "Voluptatem nulla perspiciatis officia quia natus impedit.",
"state_checksum": "d21c1662d8ce2c74f24efdc8db93eb34473b86810aeccca4b1518f70b0ccde8f",
"tags": {"foo": "bar"
},
"terraform_plan_json": "f9e21473daaa2674d862b67a1339f4570e86de17",
"terraform_state": "fc1200c7a7aa52109d762a9f005b149abef01479",
"terraform_state_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"terraform_variable_files": [{"repository": "Nemo reiciendis.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Porro et.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{"repository": "Nemo reiciendis.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Porro et.",
"repository_path": "",
"repository_sha": "abc10ed"
}
],
"terraform_variables": {"Unde voluptatem velit possimus.": {"key": "i5",
"value": "Rerum cumque.",
"value_type": "secret"
}
},
"variable_sets": ["Inventore ad cupiditate.",
"Doloribus quos enim accusantium.",
"Et saepe rerum non adipisci.",
"Qui voluptatum veritatis dolore aspernatur velit expedita."
]
}

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"
},
{"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"
},
{"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"
},
{"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: cpi
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: 37j
identifier required	string [ 1 .. 128 ] characters Identifier is the project identifier. Example: xg

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: mz

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: 98x
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: pc
identifier required	string [ 1 .. 128 ] characters Identifier is the project identifier. Example: i2

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: k

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": "py",
"associated_template": {"template_id": "zx",
"version": "3"
},
"backend_locked": true,
"budget": 0.009476694,
"cost_breakdown_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"cost_diff_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"cost_estimation_enabled": true,
"created": 34320627300546350,
"default_pipelines": {"Aut sit distinctio.": {"project_pipeline": "Voluptas minus perspiciatis aliquam.",
"workspace_pipeline": "Nihil et id ducimus explicabo fuga inventore."
},
"In sed velit qui voluptate.": {"project_pipeline": "Voluptas minus perspiciatis aliquam.",
"workspace_pipeline": "Nihil et id ducimus explicabo fuga inventore."
}
},
"description": "this is a more detailed explanation of the resource.",
"environment_variables": {"Omnis tenetur dolores.": {"created": 3806278365598465000,
"key": "46",
"updated": 4928358569030762000,
"value": "Id sint quam.",
"value_type": "secret"
}
},
"identifier": "1zq",
"modules_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"name": "resource name",
"org": "ncu",
"project": "k",
"provider_connector": "In aperiam et consequuntur aut omnis enim.",
"provider_connectors": [{"connector_ref": "ud",
"created": 1627590400,
"id": 5431443114581221000,
"type": "aws",
"updated": 1627686800,
"workspace_id": 8735968129367883000
},
{"connector_ref": "ud",
"created": 1627590400,
"id": 5431443114581221000,
"type": "aws",
"updated": 1627686800,
"workspace_id": 8735968129367883000
},
{"connector_ref": "ud",
"created": 1627590400,
"id": 5431443114581221000,
"type": "aws",
"updated": 1627686800,
"workspace_id": 8735968129367883000
},
{"connector_ref": "ud",
"created": 1627590400,
"id": 5431443114581221000,
"type": "aws",
"updated": 1627686800,
"workspace_id": 8735968129367883000
}
],
"providers_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"provisioner": "opentofu",
"provisioner_data": "Voluptas eaque aut.",
"provisioner_version": "Error ut.",
"repository": "Recusandae error maxime.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Dolorem ut velit.",
"repository_path": "",
"repository_sha": "abc10ed",
"repository_submodules": "recursive",
"sparse_checkout": "Deleniti debitis perferendis et quaerat labore.",
"state_checksum": "d21c1662d8ce2c74f24efdc8db93eb34473b86810aeccca4b1518f70b0ccde8f",
"status": "provisioning",
"tags": {"foo": "bar"
},
"terraform_plan_json": "f9e21473daaa2674d862b67a1339f4570e86de17",
"terraform_state": "fc1200c7a7aa52109d762a9f005b149abef01479",
"terraform_state_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"terraform_variable_files": [{"repository": "Optio sed debitis incidunt est fugiat eos.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Tempora quos.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{"repository": "Optio sed debitis incidunt est fugiat eos.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Tempora quos.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{"repository": "Optio sed debitis incidunt est fugiat eos.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Tempora quos.",
"repository_path": "",
"repository_sha": "abc10ed"
}
],
"terraform_variables": {"Est vel.": {"created": 3806278365598465000,
"key": "46",
"updated": 4928358569030762000,
"value": "Id sint quam.",
"value_type": "secret"
}
},
"updated": 5050652216941577000,
"variable_sets": ["Omnis occaecati enim illo.",
"Molestias nemo ut.",
"Voluptatibus distinctio laudantium."
]
}

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

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: h5

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.
	Array of objects (WorkspaceProviderConnector) define an array of provider connectors that belong to 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
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.086352475,
"cost_estimation_enabled": true,
"default_pipelines": {"Corporis ipsa quis.": {"project_pipeline": "Optio quos sunt magni reiciendis.",
"workspace_pipeline": "Aperiam ipsum aperiam quis."
},
"Itaque recusandae aliquid cumque.": {"project_pipeline": "Optio quos sunt magni reiciendis.",
"workspace_pipeline": "Aperiam ipsum aperiam quis."
},
"Quod sequi impedit.": {"project_pipeline": "Optio quos sunt magni reiciendis.",
"workspace_pipeline": "Aperiam ipsum aperiam quis."
}
},
"description": "this is a more detailed explanation of the resource.",
"environment_variables": {"Qui quaerat magni.": {"key": "i5",
"value": "Rerum cumque.",
"value_type": "secret"
},
"Sequi perferendis unde iure voluptas.": {"key": "i5",
"value": "Rerum cumque.",
"value_type": "secret"
}
},
"name": "resource name",
"provider_connector": "Tenetur ut cupiditate eaque.",
"provider_connectors": [{"connector_ref": "h8h",
"created": 1627590400,
"id": 3972048360848832500,
"type": "gcp",
"updated": 1627686800,
"workspace_id": 7356608592720691000
},
{"connector_ref": "h8h",
"created": 1627590400,
"id": 3972048360848832500,
"type": "gcp",
"updated": 1627686800,
"workspace_id": 7356608592720691000
},
{"connector_ref": "h8h",
"created": 1627590400,
"id": 3972048360848832500,
"type": "gcp",
"updated": 1627686800,
"workspace_id": 7356608592720691000
},
{"connector_ref": "h8h",
"created": 1627590400,
"id": 3972048360848832500,
"type": "gcp",
"updated": 1627686800,
"workspace_id": 7356608592720691000
}
],
"provisioner": "terraform",
"provisioner_version": "Totam dolor pariatur.",
"repository": "Vel cumque autem nihil porro quibusdam.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Ipsum pariatur laboriosam et praesentium.",
"repository_path": "",
"repository_sha": "abc10ed",
"repository_submodules": "recursive",
"sparse_checkout": "Vitae rem culpa accusamus consequatur.",
"tags": {"foo": "bar"
},
"terraform_variable_files": [{"repository": "Nemo reiciendis.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Porro et.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{"repository": "Nemo reiciendis.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Porro et.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{"repository": "Nemo reiciendis.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Porro et.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{"repository": "Nemo reiciendis.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Porro et.",
"repository_path": "",
"repository_sha": "abc10ed"
}
],
"terraform_variables": {"Molestias possimus laboriosam vero quasi.": {"key": "i5",
"value": "Rerum cumque.",
"value_type": "secret"
},
"Quis aut inventore illum quae.": {"key": "i5",
"value": "Rerum cumque.",
"value_type": "secret"
},
"Reprehenderit doloremque aut.": {"key": "i5",
"value": "Rerum cumque.",
"value_type": "secret"
}
},
"variable_sets": ["Eligendi omnis facere.",
"Doloribus quod repellat unde modi libero cum.",
"Id voluptas soluta aut enim."
]
}

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"
},
{"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"
},
{"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"
},
{"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: h1
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: h9
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: ehf

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: k
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: 5
identifier required	string [ 1 .. 128 ] characters Identifier is the project identifier. Example: 4il

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: lu

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

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

{"data_sources": [{"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"
}
],
"outputs": [{"name": "instance_public_ip",
"sensitive": true,
"value": "Possimus id sint."
},
{"name": "instance_public_ip",
"sensitive": true,
"value": "Possimus id sint."
}
],
"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: t
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: ogs
workspace required	string Example: Quis quibusdam similique totam labore qui molestias.

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: 1

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": "7",
"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"
},
{"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"
},
{"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"
},
{"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: 53
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: s
workspace required	string Workspace identifier Example: Nemo ut numquam nesciunt voluptas.

query Parameters

pipeline_execution_id	string Filter by pipeline execution ID Example: pipeline_execution_id=A sit culpa qui.
pipeline_stage_id	string Filter by pipeline execution stage ID Example: pipeline_stage_id=Libero consequatur rerum nihil fugiat est dolorem.
provisioner_type	string Filter by provisioner type Example: provisioner_type=Excepturi voluptatem nesciunt impedit doloremque qui.
data_type	string Filter by data type Example: data_type=Architecto enim velit.
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: ph

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": "7k",
"created": 8660668924312509000,
"data_type": "state_raw",
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"org": "m",
"pipeline_execution_id": "Ut quis possimus et.",
"pipeline_id": "Ipsum dolore soluta optio.",
"pipeline_stage_id": "Rerum quidem voluptatem est dignissimos ut.",
"project": "v9a",
"provisioner_type": "tf",
"stage_id": "Adipisci nesciunt laboriosam est aut.",
"workspace": "workspace123"
},
{"account": "7k",
"created": 8660668924312509000,
"data_type": "state_raw",
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"org": "m",
"pipeline_execution_id": "Ut quis possimus et.",
"pipeline_id": "Ipsum dolore soluta optio.",
"pipeline_stage_id": "Rerum quidem voluptatem est dignissimos ut.",
"project": "v9a",
"provisioner_type": "tf",
"stage_id": "Adipisci nesciunt laboriosam est aut.",
"workspace": "workspace123"
},
{"account": "7k",
"created": 8660668924312509000,
"data_type": "state_raw",
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"org": "m",
"pipeline_execution_id": "Ut quis possimus et.",
"pipeline_id": "Ipsum dolore soluta optio.",
"pipeline_stage_id": "Rerum quidem voluptatem est dignissimos ut.",
"project": "v9a",
"provisioner_type": "tf",
"stage_id": "Adipisci nesciunt laboriosam est aut.",
"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: bvq
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: iv2
workspace required	string Workspace identifier Example: workspace123

query Parameters

pipeline_id required	string The unique identifier for the associated pipeline Example: pipeline_id=Blanditiis delectus sed.
stage_id required	string The unique identifier for a stage Example: stage_id=Dolorem quos esse rerum.
pipeline_execution_id required	string The unique identifier for the associated pipeline execution Example: pipeline_execution_id=Ut omnis qui quam debitis.
pipeline_stage_id required	string The unique identifier for the associated pipeline execution stage Example: pipeline_stage_id=Et non saepe est amet pariatur.
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=plan_human
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: qxc
Content-Length	integer <int64> Size in bytes of the data. Example: 6069135396113967000

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": "Eius dolor qui at quas at quod.",
"policy_id": "Nisi quasi cumque ipsa odit inventore ut.",
"policy_name": "Fuga ea.",
"policy_set_id": "Eaque ducimus ullam sunt molestiae facere.",
"policy_set_name": "Repellendus hic reprehenderit non est totam.",
"policy_status": "Animi reiciendis laudantium in."
},
{"message": "Eius dolor qui at quas at quod.",
"policy_id": "Nisi quasi cumque ipsa odit inventore ut.",
"policy_name": "Fuga ea.",
"policy_set_id": "Eaque ducimus ullam sunt molestiae facere.",
"policy_set_name": "Repellendus hic reprehenderit non est totam.",
"policy_status": "Animi reiciendis laudantium in."
},
{"message": "Eius dolor qui at quas at quod.",
"policy_id": "Nisi quasi cumque ipsa odit inventore ut.",
"policy_name": "Fuga ea.",
"policy_set_id": "Eaque ducimus ullam sunt molestiae facere.",
"policy_set_name": "Repellendus hic reprehenderit non est totam.",
"policy_status": "Animi reiciendis laudantium in."
}
],
"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: oca
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: b
workspace required	string Workspace is the resource workspace this variable is associated with. Example: Dicta earum.
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: ck

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: 9lf
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: k5a
workspace required	string Workspace is the resource workspace this variable is associated with. Example: Voluptatum mollitia repellendus velit qui veniam.
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=Explicabo eveniet aut.
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: tmi

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": "Eius dolor qui at quas at quod.",
"policy_id": "Nisi quasi cumque ipsa odit inventore ut.",
"policy_name": "Fuga ea.",
"policy_set_id": "Eaque ducimus ullam sunt molestiae facere.",
"policy_set_name": "Repellendus hic reprehenderit non est totam.",
"policy_status": "Animi reiciendis laudantium in."
},
{"message": "Eius dolor qui at quas at quod.",
"policy_id": "Nisi quasi cumque ipsa odit inventore ut.",
"policy_name": "Fuga ea.",
"policy_set_id": "Eaque ducimus ullam sunt molestiae facere.",
"policy_set_name": "Repellendus hic reprehenderit non est totam.",
"policy_status": "Animi reiciendis laudantium in."
},
{"message": "Eius dolor qui at quas at quod.",
"policy_id": "Nisi quasi cumque ipsa odit inventore ut.",
"policy_name": "Fuga ea.",
"policy_set_id": "Eaque ducimus ullam sunt molestiae facere.",
"policy_set_name": "Repellendus hic reprehenderit non est totam.",
"policy_status": "Animi reiciendis laudantium in."
}
],
"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: u
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: r1f
workspace required	string [ 1 .. 1024 ] characters Workspace associated with this event Example: dy4

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: g

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": {"Molestiae ea ut.": "Nihil magni dolor."
},
"event_type": "provisioning",
"metadata": {"PlannedChangesCount": 2452092610264062000,
"activity_status": "failure",
"activity_type": "import",
"cost_breakdown_uuid": "Maxime eum est fuga inventore.",
"cost_currency": "Tenetur nesciunt.",
"cost_diff_total_monthly": "Rem ipsam qui numquam nemo.",
"cost_diff_uuid": "Ea natus possimus.",
"cost_past_total_monthly": "A modi dolores quia rerum.",
"cost_total_monthly": "Facilis quia officiis eveniet.",
"cost_total_monthly_percentage_change": "Molestias nemo quos.",
"drift_counts": {"added": 1926069642079262000,
"changed": 6644572953107601000,
"deleted": 8213593984185752000,
"unchanged": 1083001572762766100
},
"enable_solutions_factory": false,
"git_branch": "Deserunt a similique quibusdam incidunt officiis.",
"git_commit_message": "Eaque facilis.",
"git_commit_sha": "Neque laborum.",
"git_repo": "Dignissimos exercitationem eius illum est.",
"modules_uuid": "Consequatur numquam perspiciatis.",
"output_counts": {"added": 1926069642079262000,
"changed": 6644572953107601000,
"deleted": 8213593984185752000,
"unchanged": 1083001572762766100
},
"pipeline": "Sequi blanditiis provident atque.",
"pipeline_execution_id": "Facere aspernatur fugiat vel molestiae eveniet.",
"pipeline_execution_number": "Numquam voluptatem.",
"pipeline_name": "Eum quo omnis.",
"pipeline_stage_id": "Et provident molestiae omnis cumque aliquam placeat.",
"plan_uuid": "Eveniet eum voluptatem porro quidem quidem accusantium.",
"providers_uuid": "Iure dolorem.",
"provisioner": "Et distinctio iure animi facilis.",
"provisioner_version": "Aspernatur sit molestias alias nihil.",
"resource_counts": {"added": 1926069642079262000,
"changed": 6644572953107601000,
"deleted": 8213593984185752000,
"unchanged": 1083001572762766100
},
"state_checksum": "Similique pariatur doloremque nihil placeat.",
"state_uuid": "Assumenda autem explicabo quidem culpa occaecati et.",
"trigger": {"Officiis nisi.": "A molestiae sint iure voluptas.",
"Placeat qui accusamus.": "Ea et aliquid.",
"Ut animi voluptatibus voluptatibus.": "Aperiam similique."
}
},
"pipeline_execution_id": "Odit natus et nihil quas.",
"pipeline_stage_id": "Est culpa ut saepe sit."
}

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: mq
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: dcm
workspace required	string Workspace identifier Example: Adipisci eaque doloribus quia vero enim.

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

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": "s",
"org": "0",
"pipelines": ["Et magnam dignissimos qui odit aut.",
"Ratione quia rerum quidem.",
"Voluptate aliquid et neque qui."
],
"project": "p"
}

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: 5k
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: zr4
workspace required	string The workspace associated with the remote execution. Example: Laudantium laudantium qui ducimus ea earum.

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: a2

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": {"A accusantium tenetur consequuntur.": ["Odit sequi sit vitae aliquam.",
"Reprehenderit libero fugiat.",
"Consectetur delectus delectus veritatis sint.",
"Aut blanditiis."
],
"Dolor iste eaque.": ["Labore aperiam repellat.",
"Vitae mollitia consequuntur qui facilis dolor quia."
]
}
}

Response samples

application/json

{"account": "p",
"created": 5201359725552042000,
"custom_arguments": {"Dignissimos eos natus quia suscipit nostrum.": ["At sunt perferendis.",
"Dolorem velit vel occaecati mollitia tenetur quis.",
"Debitis quas facere.",
"Consequuntur voluptatem ratione."
],
"Fugiat omnis aut laborum est porro ullam.": ["Iure adipisci ea voluptate a.",
"Ut quidem explicabo."
],
"Pariatur voluptates voluptatem.": ["Quaerat ea nemo ut voluptas facilis.",
"Sit vel qui id."
]
},
"executed": false,
"id": "c4cda836-6ff0-4a73-8fa9-3ae2f99d028a",
"org": "1",
"pipeline_execution_id": "Atque iusto quis.",
"pipeline_execution_url": "Earum eum et sapiente et quod.",
"project": "1ni",
"sha256_checksum": "Amet mollitia et voluptate omnis minima laboriosam.",
"updated": 1115410022123217300,
"workspace": "Ex asperiores."
}

Show remote execution

Find remote execution

Securityx-api-key

Request

path Parameters

org required	string [ 1 .. 128 ] characters Org is the organisation identifier. Example: 9
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: 1n
workspace required	string Workspace is the resource workspace this variable is associated with. Example: Voluptatibus ad qui esse repudiandae tempore aut.
id required	string <uuid> The ID of the remote execution Example: f864e961-13f0-472a-b912-fabb6b2f84b4

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: 0r

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": "n",
"created": 6901230229512400000,
"custom_arguments": {"Facilis delectus doloribus laborum ex soluta cupiditate.": ["Dignissimos aut dolorum tenetur.",
"Qui veritatis cumque assumenda.",
"Aut ut officiis aut.",
"Dolore fugiat ut assumenda veniam quidem."
]
},
"executed": true,
"id": "c9dcbfe2-2fd8-4921-b968-59120f5f44cb",
"org": "he",
"pipeline_execution_id": "At aspernatur alias quidem ab tempora sed.",
"pipeline_execution_url": "Et quidem tempore voluptatum earum iure provident.",
"project": "u7a",
"sha256_checksum": "Dolor sed sit ipsam incidunt laboriosam vel.",
"updated": 907821693697979600,
"workspace": "Facere soluta illo non."
}

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: 8l
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: w9y
workspace required	string Workspace is the resource workspace this variable is associated with. Example: Quae quisquam saepe modi.
id required	string <uuid> The ID of the remote execution Example: c471460d-1d0c-421e-91bf-6f1120c1db8b

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: 34

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: wv4
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: tm
workspace required	string Workspace is the resource workspace this variable is associated with. Example: Architecto quam.
id required	string <uuid> The ID of the remote execution Example: 02c7f23f-51d0-403e-880a-fdb0d78658da

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: 6zf

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": "fj1",
"created": 6064672155280667000,
"custom_arguments": {"Provident beatae non veniam.": ["Assumenda labore et nisi.",
"Accusantium a eum et dolorem.",
"Adipisci quidem dicta.",
"Tempora sit sequi neque."
],
"Quasi quia.": ["Tempore ipsam ea quia eveniet vitae perferendis.",
"Aut assumenda et magni architecto.",
"Ut ratione.",
"Impedit sed quam quisquam enim."
]
},
"executed": false,
"id": "48ea8dde-6a7e-4070-ae4e-d583873203ae",
"org": "ps",
"pipeline_execution_id": "Temporibus laudantium.",
"pipeline_execution_url": "Voluptatum repellendus modi eum voluptas ut animi.",
"project": "rci",
"sha256_checksum": "Vel beatae et consequatur aliquam.",
"updated": 8942566710390643000,
"workspace": "Doloremque animi."
}

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: ue
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: 5zd
workspace required	string Workspace is the resource workspace this variable is associated with. Example: Consectetur hic molestias dolorem assumenda.
id required	string <uuid> The ID of the remote execution Example: 07809c9e-8ed7-44cd-a9da-3689710ab189

header Parameters

Harness-Account required	string [ 1 .. 128 ] characters Account is the internal customer account ID. Example: a
Content-Length	integer <int64> Size in bytes of the source code. Example: 1044803321604207500
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: Cupiditate nisi.

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": "ce0",
"created": 27741312053188064,
"custom_arguments": {"Et et rerum maiores beatae quasi architecto.": ["Consequatur omnis aperiam.",
"Voluptas odio.",
"Tenetur quo dolore.",
"Repellat sit alias ut consequatur expedita."
],
"Fugit est non.": ["Aut aut aut nihil.",
"Saepe qui."
],
"Perspiciatis rem vel molestiae.": ["Eum rerum dolorem.",
"Et voluptate voluptas."
]
},
"executed": false,
"id": "732f30f0-f0dc-442d-8b61-14f03dbe5200",
"org": "oxd",
"pipeline_execution_id": "Impedit in dolor est ab.",
"pipeline_execution_url": "Vel nam atque.",
"project": "k",
"sha256_checksum": "Fuga rem aperiam.",
"updated": 4558187102902579000,
"workspace": "Eius repudiandae aut."
}

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

query Parameters

start_time	integer <int64> Start time filter (Unix timestamp) Example: start_time=7764560712126353000
end_time	integer <int64> End time filter (Unix timestamp) Example: end_time=7508984934054968000

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: g

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": {"Dolor accusamus cum.": 0.29927427279442853,
"Totam dolorum accusantium possimus.": 0.7454666798653101
},
"total": 0.8914537451967556
}

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

query Parameters

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

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account identifier.

Example: s

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": "8jg",
"created_at": 1627590400,
"org": "l",
"project": "c",
"template_id": "p",
"updated_at": 1627686800,
"version": "ru",
"workspace_id": "f"
},
{"account": "8jg",
"created_at": 1627590400,
"org": "l",
"project": "c",
"template_id": "p",
"updated_at": 1627686800,
"version": "ru",
"workspace_id": "f"
},
{"account": "8jg",
"created_at": 1627590400,
"org": "l",
"project": "c",
"template_id": "p",
"updated_at": 1627686800,
"version": "ru",
"workspace_id": "f"
}
]

➔ Next to settings

workspaces

List all workspace tags

path Parameters

header Parameters

Show workspace metrics

path Parameters

query 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

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