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

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: jr

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

["Natus aliquid quae.",
"Laboriosam doloremque fuga fugit.",
"Nulla in veritatis maxime et dolores eligendi.",
"Nulla aut facere."
]

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

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: 1

Responses

200

OK response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

get/iacm/api/orgs/{org}/projects/{project}/workspace-metrics

Request samples

curl
Java
Go

Response samples

application/json

{"status_counts": {"Autem ea aut possimus aut inventore et.": 3907121995714944500,
"Ipsum quis quod.": 320476511368940000,
"Porro maiores.": 268859755614875100
}
}

List workspaces

List all workspaces.

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

query Parameters

limit	integer <int64> [ 1 .. 1000 ] Default: 30 Limit is the number of records to return for a page. Example: limit=30
page	integer <int64> >= 1 Default: 1 Page is the page number to return relative to the page 'limit'. Example: page=1
searchTerm	string Default: "" Filter results by partial name match Example: searchTerm=mysta
sort	string Default: "name,ASC" Sort order for results Enum: "name,ASC" "name,DESC" "updated,ASC" "updated,DESC" Example: sort=name,ASC
status	Array of strings Status of the execution Example: status=Ducimus sit.&status=Dignissimos optio.
tags	Array of strings Comma separated list of tags to filter by Example: tags=Facere velit labore ut repellendus rerum.&tags=Deleniti eius sit ut omnis corporis.&tags=Placeat voluptate delectus necessitatibus.&tags=Natus facere consequatur repellat.

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

Request samples

curl
Java
Go

Response samples

application/json

[{"account": "qx",
"created": 5710773867289513000,
"description": "this is a more detailed explanation of the resource.",
"identifier": "a",
"name": "resource name",
"org": "4",
"project": "hxn",
"status": "provisioning",
"updated": 4776096143620899000
},
{"account": "qx",
"created": 5710773867289513000,
"description": "this is a more detailed explanation of the resource.",
"identifier": "a",
"name": "resource name",
"org": "4",
"project": "hxn",
"status": "provisioning",
"updated": 4776096143620899000
},
{"account": "qx",
"created": 5710773867289513000,
"description": "this is a more detailed explanation of the resource.",
"identifier": "a",
"name": "resource name",
"org": "4",
"project": "hxn",
"status": "provisioning",
"updated": 4776096143620899000
},
{"account": "qx",
"created": 5710773867289513000,
"description": "this is a more detailed explanation of the resource.",
"identifier": "a",
"name": "resource name",
"org": "4",
"project": "hxn",
"status": "provisioning",
"updated": 4776096143620899000
}
]

Create workspace

Create a new workspace.

Securityx-api-key

Request

path Parameters

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

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: e

Request Body schema: application/json
required

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

Responses

200

OK response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

post/iacm/api/orgs/{org}/projects/{project}/workspaces

Request samples

Payload
curl
Java
Go

application/json

{"associated_template": {"template_id": "uw",
"version": "sye"
},
"budget": 0.12296778,
"cost_breakdown_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"cost_diff_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"cost_estimation_enabled": true,
"default_pipelines": {"Cumque doloribus quisquam.": {"project_pipeline": "Voluptas quo ex.",
"workspace_pipeline": "Autem quis fugit voluptatem nulla magni quisquam."
},
"Qui iure rerum.": {"project_pipeline": "Voluptas quo ex.",
"workspace_pipeline": "Autem quis fugit voluptatem nulla magni quisquam."
}
},
"description": "this is a more detailed explanation of the resource.",
"environment_variables": {"Sit laborum aut.": {"key": "s92",
"value": "Repudiandae ut consectetur eaque.",
"value_type": "secret"
},
"Unde in.": {"key": "s92",
"value": "Repudiandae ut consectetur eaque.",
"value_type": "secret"
}
},
"identifier": "pnv",
"modules_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"name": "resource name",
"provider_connector": "Rem illum accusantium ut voluptate.",
"providers_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"provisioner": "terraform",
"provisioner_version": "Sed assumenda.",
"repository": "Qui placeat quidem.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Explicabo debitis odit hic porro.",
"repository_path": "",
"repository_sha": "abc10ed",
"repository_submodules": "recursive",
"sparse_checkout": "Nostrum nostrum molestiae et est porro.",
"state_checksum": "d21c1662d8ce2c74f24efdc8db93eb34473b86810aeccca4b1518f70b0ccde8f",
"tags": {"foo": "bar"
},
"terraform_plan_json": "f9e21473daaa2674d862b67a1339f4570e86de17",
"terraform_state": "fc1200c7a7aa52109d762a9f005b149abef01479",
"terraform_state_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"terraform_variable_files": [{"repository": "Voluptatem non temporibus inventore eos officiis.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Nam ex maxime consequatur dolor facere.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{"repository": "Voluptatem non temporibus inventore eos officiis.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Nam ex maxime consequatur dolor facere.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{"repository": "Voluptatem non temporibus inventore eos officiis.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Nam ex maxime consequatur dolor facere.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{"repository": "Voluptatem non temporibus inventore eos officiis.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Nam ex maxime consequatur dolor facere.",
"repository_path": "",
"repository_sha": "abc10ed"
}
],
"terraform_variables": {"Eveniet suscipit deserunt exercitationem sit consequatur.": {"key": "s92",
"value": "Repudiandae ut consectetur eaque.",
"value_type": "secret"
},
"Sit consequuntur dolores et magni aliquid.": {"key": "s92",
"value": "Repudiandae ut consectetur eaque.",
"value_type": "secret"
}
},
"variable_sets": ["Excepturi ad qui.",
"Earum vel tenetur odit beatae ipsum excepturi.",
"Labore nihil deleniti inventore qui ipsa.",
"Voluptatem et vel."
]
}

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

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: x

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

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: o90

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": "51y",
"associated_template": {"template_id": "b",
"version": "av"
},
"backend_locked": false,
"budget": 0.08924627,
"cost_breakdown_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"cost_diff_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"cost_estimation_enabled": true,
"created": 5066140238654963000,
"default_pipelines": {"Et nemo sit.": {"project_pipeline": "Quasi et.",
"workspace_pipeline": "Qui mollitia et et."
},
"In amet aut.": {"project_pipeline": "Quasi et.",
"workspace_pipeline": "Qui mollitia et et."
}
},
"description": "this is a more detailed explanation of the resource.",
"environment_variables": {"Eos dolores eum.": {"created": 8542543872474560000,
"key": "p0",
"updated": 623614010275926800,
"value": "Officia ipsum id inventore asperiores magnam omnis.",
"value_type": "string"
},
"Esse reprehenderit.": {"created": 8542543872474560000,
"key": "p0",
"updated": 623614010275926800,
"value": "Officia ipsum id inventore asperiores magnam omnis.",
"value_type": "string"
},
"Quia illum.": {"created": 8542543872474560000,
"key": "p0",
"updated": 623614010275926800,
"value": "Officia ipsum id inventore asperiores magnam omnis.",
"value_type": "string"
}
},
"identifier": "7",
"modules_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"name": "resource name",
"org": "0j",
"project": "tm",
"provider_connector": "Et aut non.",
"providers_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"provisioner": "terraform",
"provisioner_data": "Eum totam aut in.",
"provisioner_version": "Inventore consequatur qui dolores ipsum autem.",
"repository": "Eligendi corporis eum.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Nisi dolor harum illo.",
"repository_path": "",
"repository_sha": "abc10ed",
"repository_submodules": "recursive",
"sparse_checkout": "Qui nesciunt maiores rem necessitatibus natus odit.",
"state_checksum": "d21c1662d8ce2c74f24efdc8db93eb34473b86810aeccca4b1518f70b0ccde8f",
"status": "active",
"tags": {"foo": "bar"
},
"terraform_plan_json": "f9e21473daaa2674d862b67a1339f4570e86de17",
"terraform_state": "fc1200c7a7aa52109d762a9f005b149abef01479",
"terraform_state_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"terraform_variable_files": [{"repository": "Sequi consectetur reprehenderit nobis aperiam dolorem.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Reprehenderit nisi voluptatibus repellendus delectus quo.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{"repository": "Sequi consectetur reprehenderit nobis aperiam dolorem.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Reprehenderit nisi voluptatibus repellendus delectus quo.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{"repository": "Sequi consectetur reprehenderit nobis aperiam dolorem.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Reprehenderit nisi voluptatibus repellendus delectus quo.",
"repository_path": "",
"repository_sha": "abc10ed"
}
],
"terraform_variables": {"Culpa consectetur voluptas amet sed.": {"created": 8542543872474560000,
"key": "p0",
"updated": 623614010275926800,
"value": "Officia ipsum id inventore asperiores magnam omnis.",
"value_type": "string"
},
"Molestiae reiciendis.": {"created": 8542543872474560000,
"key": "p0",
"updated": 623614010275926800,
"value": "Officia ipsum id inventore asperiores magnam omnis.",
"value_type": "string"
},
"Odio illo sapiente ut.": {"created": 8542543872474560000,
"key": "p0",
"updated": 623614010275926800,
"value": "Officia ipsum id inventore asperiores magnam omnis.",
"value_type": "string"
}
},
"updated": 5895057065149330000,
"variable_sets": ["Mollitia sed consequatur tenetur nobis.",
"Dolor rem adipisci esse."
]
}

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

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: 89

Request Body schema: application/json
required

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

Responses

200

OK response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

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

Request samples

Payload
curl
Java
Go

application/json

{"budget": 0.9958707,
"cost_estimation_enabled": true,
"default_pipelines": {"Repellendus corporis saepe ad non.": {"project_pipeline": "Voluptas quo ex.",
"workspace_pipeline": "Autem quis fugit voluptatem nulla magni quisquam."
}
},
"description": "this is a more detailed explanation of the resource.",
"environment_variables": {"Et soluta minima.": {"key": "s92",
"value": "Repudiandae ut consectetur eaque.",
"value_type": "secret"
},
"Vitae debitis dolorum.": {"key": "s92",
"value": "Repudiandae ut consectetur eaque.",
"value_type": "secret"
}
},
"name": "resource name",
"provider_connector": "Molestiae iusto.",
"provisioner": "terraform",
"provisioner_version": "Ullam similique.",
"repository": "Dolores odio placeat et.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Aut doloremque rerum id.",
"repository_path": "",
"repository_sha": "abc10ed",
"repository_submodules": "recursive",
"sparse_checkout": "Accusamus harum aliquid minus.",
"tags": {"foo": "bar"
},
"terraform_variable_files": [{"repository": "Voluptatem non temporibus inventore eos officiis.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Nam ex maxime consequatur dolor facere.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{"repository": "Voluptatem non temporibus inventore eos officiis.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Nam ex maxime consequatur dolor facere.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{"repository": "Voluptatem non temporibus inventore eos officiis.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Nam ex maxime consequatur dolor facere.",
"repository_path": "",
"repository_sha": "abc10ed"
}
],
"terraform_variables": {"Nemo enim voluptate natus.": {"key": "s92",
"value": "Repudiandae ut consectetur eaque.",
"value_type": "secret"
},
"Sed quia aliquam eligendi.": {"key": "s92",
"value": "Repudiandae ut consectetur eaque.",
"value_type": "secret"
}
},
"variable_sets": ["Rerum cumque et dicta.",
"Saepe labore."
]
}

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

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: sb

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

Responses

200

OK response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

get/iacm/api/orgs/{org}/projects/{project}/workspaces/{identifier}/modules

Request samples

curl
Java
Go

Response samples

application/json

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

List resources

List resources associated with this workspace.

Securityx-api-key

Request

path Parameters

org required	string [ 1 .. 128 ] characters Org is the organisation identifier. Example: o
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: dh
identifier required	string [ 1 .. 128 ] characters Identifier is the project identifier. Example: jqq

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: gl

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"
},
{"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": "Totam consequatur."
},
{"name": "instance_public_ip",
"sensitive": true,
"value": "Totam consequatur."
},
{"name": "instance_public_ip",
"sensitive": true,
"value": "Totam consequatur."
}
],
"resources": [{"attributes": {"ami": "ami-830c94ec",
"instance_type": "t2.micro"
},
"drift_attributes": {"instance_type": "t2.nano"
},
"drift_status": "changed",
"module": "full_stack",
"name": "app_server",
"provider": "AWS",
"sensitive_attributes": ["instance_type"
],
"type": "S3 Bucket"
},
{"attributes": {"ami": "ami-830c94ec",
"instance_type": "t2.micro"
},
"drift_attributes": {"instance_type": "t2.nano"
},
"drift_status": "changed",
"module": "full_stack",
"name": "app_server",
"provider": "AWS",
"sensitive_attributes": ["instance_type"
],
"type": "S3 Bucket"
},
{"attributes": {"ami": "ami-830c94ec",
"instance_type": "t2.micro"
},
"drift_attributes": {"instance_type": "t2.nano"
},
"drift_status": "changed",
"module": "full_stack",
"name": "app_server",
"provider": "AWS",
"sensitive_attributes": ["instance_type"
],
"type": "S3 Bucket"
},
{"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: q
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: h
workspace required	string Example: Saepe quo totam aut sed.

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: jv7

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": "3j",
"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
}
],
"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: g
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: l
workspace required	string Workspace identifier Example: Et eum assumenda culpa.

query Parameters

pipeline_execution_id	string Filter by pipeline execution ID Example: pipeline_execution_id=Iste quia corporis qui.
pipeline_stage_id	string Filter by pipeline execution stage ID Example: pipeline_stage_id=Totam deleniti accusamus accusamus nulla.
provisioner_type	string Filter by provisioner type Example: provisioner_type=Nobis non sit quia aperiam eligendi doloribus.
data_type	string Filter by data type Example: data_type=Modi nesciunt modi labore perferendis harum.
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: xio

Responses

200

OK response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

get/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/data

Request samples

curl
Java
Go

Response samples

application/json

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

Create data

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

Securityx-api-key

Request

path Parameters

org required	string [ 1 .. 128 ] characters Org is the organisation identifier. Example: 7ez
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: 4c
workspace required	string Workspace identifier Example: workspace123

query Parameters

pipeline_id required	string The unique identifier for the associated pipeline Example: pipeline_id=Rerum accusantium asperiores sit.
stage_id required	string The unique identifier for a stage Example: stage_id=Illo aut id sit perferendis.
pipeline_execution_id required	string The unique identifier for the associated pipeline execution Example: pipeline_execution_id=Maxime cumque voluptas dolores sed.
pipeline_stage_id required	string The unique identifier for the associated pipeline execution stage Example: pipeline_stage_id=Molestiae excepturi illo ullam iste id.
provisioner_type required	string Type of provisioner that created the data Value: "tf" Example: provisioner_type=tf
data_type required	string Type of data stored Enum: "plan_human" "state_raw" "state_human" "cost_breakdown" "cost_diff" "modules" "providers" Example: data_type=cost_diff
policy_action	string Policy action used during OPA evaluation Example: policy_action=afterTerraformApply

header Parameters

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

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": "Est aut dolores id.",
"policy_id": "Consequatur blanditiis.",
"policy_name": "Aut provident eum fuga voluptatem perspiciatis.",
"policy_set_id": "Enim ipsam doloribus dolores suscipit.",
"policy_set_name": "Quia nemo voluptatem aspernatur accusantium quidem hic.",
"policy_status": "Eveniet sit."
},
{"message": "Est aut dolores id.",
"policy_id": "Consequatur blanditiis.",
"policy_name": "Aut provident eum fuga voluptatem perspiciatis.",
"policy_set_id": "Enim ipsam doloribus dolores suscipit.",
"policy_set_name": "Quia nemo voluptatem aspernatur accusantium quidem hic.",
"policy_status": "Eveniet sit."
}
],
"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: v7
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: 8
workspace required	string Workspace is the resource workspace this variable is associated with. Example: Quis repellat et consequuntur non.
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: fv3

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: 52
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: 7r1
workspace required	string Workspace is the resource workspace this variable is associated with. Example: Ut sed in est.
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=Repellat distinctio occaecati eos provident.
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: 9t

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": "Est aut dolores id.",
"policy_id": "Consequatur blanditiis.",
"policy_name": "Aut provident eum fuga voluptatem perspiciatis.",
"policy_set_id": "Enim ipsam doloribus dolores suscipit.",
"policy_set_name": "Quia nemo voluptatem aspernatur accusantium quidem hic.",
"policy_status": "Eveniet sit."
},
{"message": "Est aut dolores id.",
"policy_id": "Consequatur blanditiis.",
"policy_name": "Aut provident eum fuga voluptatem perspiciatis.",
"policy_set_id": "Enim ipsam doloribus dolores suscipit.",
"policy_set_name": "Quia nemo voluptatem aspernatur accusantium quidem hic.",
"policy_status": "Eveniet sit."
}
],
"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: t
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: 7x
workspace required	string [ 1 .. 1024 ] characters Workspace associated with this event Example: oh

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: p

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": {"Veniam et ipsum officia non vel architecto.": "Blanditiis necessitatibus a impedit minus."
},
"event_type": "provisioning",
"metadata": {"PlannedChangesCount": 227354008010053950,
"activity_status": "success",
"activity_type": "drifted",
"cost_breakdown_uuid": "Aut aut aut dignissimos sit voluptates quibusdam.",
"cost_currency": "Et quis fuga doloremque harum quis.",
"cost_diff_total_monthly": "Sit excepturi.",
"cost_diff_uuid": "Quis aliquid dicta hic ut illum aut.",
"cost_past_total_monthly": "Officia minus dolorem ut quibusdam maiores.",
"cost_total_monthly": "Rerum quae odio.",
"cost_total_monthly_percentage_change": "Corporis eos nesciunt.",
"drift_counts": {"added": 8858757674906414000,
"changed": 3522578289857180000,
"deleted": 7199734609571168000,
"unchanged": 2956366699229624300
},
"enable_solutions_factory": false,
"git_branch": "Dicta possimus omnis consequatur.",
"git_commit_message": "Est laborum excepturi totam deleniti quisquam.",
"git_commit_sha": "Ut dolorum nisi.",
"git_repo": "Veniam aut et aliquam autem maxime harum.",
"modules_uuid": "Iste consequatur molestiae minus.",
"output_counts": {"added": 8858757674906414000,
"changed": 3522578289857180000,
"deleted": 7199734609571168000,
"unchanged": 2956366699229624300
},
"pipeline": "Et voluptatum nisi est voluptas.",
"pipeline_execution_id": "Voluptates at.",
"pipeline_execution_number": "Consequatur autem eum ipsum.",
"pipeline_name": "Enim perspiciatis ratione enim quam repellendus illo.",
"pipeline_stage_id": "Nemo suscipit nobis aut ab dolorem.",
"plan_uuid": "Voluptatem temporibus eum sunt dolorem temporibus.",
"providers_uuid": "Rem id omnis quia aut dolor.",
"provisioner": "Quia et.",
"provisioner_version": "Sunt quae eveniet ullam quia.",
"resource_counts": {"added": 8858757674906414000,
"changed": 3522578289857180000,
"deleted": 7199734609571168000,
"unchanged": 2956366699229624300
},
"state_checksum": "Assumenda placeat atque voluptas sint aspernatur incidunt.",
"state_uuid": "Nam quis sint minus.",
"trigger": {"Esse iusto aliquam.": "Voluptates maiores fugiat eum et.",
"Odit quod ut molestiae quidem tempora alias.": "Dicta quia a eaque."
}
},
"pipeline_execution_id": "Eius earum hic id sunt doloremque.",
"pipeline_stage_id": "Debitis vero voluptas iusto facilis."
}

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: or
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: k
workspace required	string Workspace identifier Example: Asperiores iure voluptates est molestiae perferendis et.

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

get/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/pipelines

Request samples

curl
Java
Go

Response samples

application/json

{"account": "5fj",
"org": "n13",
"pipelines": ["Repellendus fugiat nemo reiciendis velit porro et.",
"Praesentium voluptas asperiores.",
"Est quia iure optio quos sunt.",
"Reiciendis sapiente aperiam ipsum."
],
"project": "ari"
}

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: 0yf
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: n
workspace required	string The workspace associated with the remote execution. Example: Voluptate voluptatem ut expedita provident.

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: zy

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": {"Mollitia dolorem omnis.": ["Repellendus aut.",
"Aliquid occaecati in.",
"Velit qui voluptate est aut sit.",
"Minus necessitatibus omnis occaecati enim illo porro."
],
"Nemo ut consequatur voluptatibus distinctio.": ["Repellat aut esse ut.",
"Asperiores aut.",
"Quidem sit architecto aliquam labore.",
"Labore vero qui placeat sint."
]
}
}

Response samples

application/json

{"account": "vt9",
"created": 4049154488295601000,
"custom_arguments": {"Doloremque aut aut.": ["Inventore illum quae cumque architecto sequi.",
"Unde iure.",
"Amet qui quaerat magni velit et.",
"A quod sequi impedit velit."
]
},
"executed": false,
"id": "453fbbb3-2b72-4371-b567-cf507dca2749",
"org": "xo",
"pipeline_execution_id": "Praesentium ducimus vitae rem culpa accusamus.",
"pipeline_execution_url": "Qui aliquid molestias.",
"project": "j2e",
"sha256_checksum": "Vero quasi.",
"updated": 4067837438472890400,
"workspace": "Porro quibusdam similique ipsum pariatur laboriosam."
}

Show remote execution

Find remote execution

Securityx-api-key

Request

path Parameters

org required	string [ 1 .. 128 ] characters Org is the organisation identifier. Example: hf
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: k
workspace required	string Workspace is the resource workspace this variable is associated with. Example: Sint harum amet veritatis optio id.
id required	string <uuid> The ID of the remote execution Example: 8a0fa6f7-9fd4-44eb-b1a9-d670f74f3135

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: tk

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": "ha",
"created": 58454111637659780,
"custom_arguments": {"Earum sunt ea.": ["Accusamus nisi ea et.",
"Fugiat officiis nisi autem a."
],
"Sint iure voluptas magnam ut animi voluptatibus.": ["Aperiam similique.",
"Dignissimos exercitationem eius illum est.",
"Neque laborum.",
"Eaque facilis."
]
},
"executed": false,
"id": "ab5028ff-063a-4a30-b344-9f02df57c6d4",
"org": "c",
"pipeline_execution_id": "Cumque aliquam placeat ut saepe.",
"pipeline_execution_url": "Et distinctio iure animi facilis.",
"project": "hg",
"sha256_checksum": "Sit molestias.",
"updated": 1524913541778651600,
"workspace": "Quia et provident molestiae."
}

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: yx5
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: bc
workspace required	string Workspace is the resource workspace this variable is associated with. Example: Est eos eaque non voluptas.
id required	string <uuid> The ID of the remote execution Example: 202b10ae-847f-456b-b963-7595020aa47c

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: i

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: ahc
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: 1kr
workspace required	string Workspace is the resource workspace this variable is associated with. Example: Et beatae perspiciatis qui et repellendus.
id required	string <uuid> The ID of the remote execution Example: af82d217-2f18-49d6-97e3-420437fc78bd

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: gd

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": "ts",
"created": 2922382896646483500,
"custom_arguments": {"Eos facere sapiente expedita ullam.": ["Eum natus.",
"Sint quidem."
],
"Id soluta.": ["Atque voluptatem saepe.",
"Ipsam qui."
]
},
"executed": true,
"id": "41869a8d-fec6-49b1-8f01-1a48f6aff809",
"org": "q0",
"pipeline_execution_id": "Adipisci ratione nemo odio ipsum aspernatur.",
"pipeline_execution_url": "Veniam consequatur quis dignissimos corporis.",
"project": "2hu",
"sha256_checksum": "Voluptatem sed possimus quis quasi.",
"updated": 1605532457460987000,
"workspace": "Vel suscipit et qui."
}

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: tek
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: yi5
workspace required	string Workspace is the resource workspace this variable is associated with. Example: Consectetur eius facere quam.
id required	string <uuid> The ID of the remote execution Example: 241cfe9b-ef28-4869-bb0f-6d40c5d682d4

header Parameters

Harness-Account required	string [ 1 .. 128 ] characters Account is the internal customer account ID. Example: 5v
Content-Length	integer <int64> Size in bytes of the source code. Example: 6070561420762577000
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: Quod sunt quia.

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": "ka7",
"created": 7980559509712199000,
"custom_arguments": {"Dolorem facere praesentium nesciunt possimus.": ["Magni vel.",
"Neque voluptas.",
"Necessitatibus quis voluptas et cum voluptas voluptas."
],
"In sint odio molestias voluptas natus.": ["Itaque nisi cumque impedit non accusamus.",
"Dolor sed illum nihil fuga quis.",
"Quo qui optio dolorum omnis nihil.",
"Rem accusamus ullam dolorum voluptatem."
],
"Quos autem deserunt qui sapiente.": ["Dicta pariatur tenetur consectetur amet aut optio.",
"Blanditiis debitis magnam adipisci est et.",
"Excepturi saepe et.",
"Odio quo dolore vel cumque nihil numquam."
]
},
"executed": false,
"id": "87c7f5d7-231e-4006-a630-ddf9e3bfb729",
"org": "pm",
"pipeline_execution_id": "Est eos sit ipsum placeat maxime.",
"pipeline_execution_url": "Ipsum ullam tempore adipisci voluptas ea.",
"project": "1w",
"sha256_checksum": "Debitis pariatur vel ut earum.",
"updated": 5835851703595412000,
"workspace": "Dolor qui at quas at."
}

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

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: 4

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": {"Cum error et et rerum maiores beatae.": 0.2892429293292318,
"Nisi natus consequatur omnis aperiam.": 0.7604451258149034,
"Odio recusandae tenetur quo dolore.": 0.39140840157123885
},
"total": 0.8405302200268504
}

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: 8s6

query Parameters

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

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account identifier.

Example: a5u

Responses

200

OK response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

get/iacm/api/workspace/templates/{template_id}

Request samples

curl
Java
Go

Response samples

application/json

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

➔ Next to settings

workspaces

List all workspace tags

path Parameters

header Parameters

Show workspace metrics

path Parameters

header Parameters

List workspaces

path Parameters

query Parameters

header Parameters

Create workspace

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Destroy workspace

path Parameters

header Parameters

Show workspace

path Parameters

header Parameters

Update workspace

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Force unlock workspace

path Parameters

header Parameters

List modules

path Parameters

header Parameters

List resources

path Parameters

header Parameters

Clone workspace

path Parameters

header Parameters

Request Body schema: application/jsonrequired

List data

path Parameters

query Parameters

header Parameters

Create data

path Parameters

query Parameters

header Parameters

Show data

path Parameters

header Parameters

Evaluate data

path Parameters

query Parameters

header Parameters

Send event

path Parameters

header Parameters

Request Body schema: application/jsonrequired

List pipelines

path Parameters

query Parameters

header Parameters

Create remote execution

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Show remote execution

path Parameters

header Parameters

Download remote exectution

path Parameters

header Parameters

execute-remote-execution workspaces

path Parameters

header Parameters

Upload remote execution source

path Parameters

header Parameters

List provisioners ratio

path Parameters

header Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required