workspaces

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

List all tags

Securityx-api-key

Request

path Parameters

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

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: kob

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

{"Nisi ipsa saepe veritatis tenetur tempora aut.": "Minus aut officiis."
}

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

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: r

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": {"Aperiam quasi porro.": 2480000993154800600,
"Nisi ex et minus minus.": 5123002518543087000,
"Pariatur dolores excepturi perferendis.": 3327690886455505400
}
}

List workspaces

List all workspaces.

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

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,DESC
status	Array of strings Status of the execution Example: status=Quo commodi.&status=Enim ipsam.
tags	Array of strings Comma separated list of tags to filter by Example: tags=Voluptatibus earum maxime.&tags=Est quasi autem suscipit consequatur praesentium magni.&tags=Cumque est dolorem.&tags=Laborum unde qui.

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: lj1

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": "5k3",
"created": 1655395860833833000,
"description": "this is a more detailed explanation of the resource.",
"identifier": "f",
"name": "resource name",
"org": "t",
"project": "z8k",
"status": "destroying",
"updated": 211033580760198270
},
{"account": "5k3",
"created": 1655395860833833000,
"description": "this is a more detailed explanation of the resource.",
"identifier": "f",
"name": "resource name",
"org": "t",
"project": "z8k",
"status": "destroying",
"updated": 211033580760198270
},
{"account": "5k3",
"created": 1655395860833833000,
"description": "this is a more detailed explanation of the resource.",
"identifier": "f",
"name": "resource name",
"org": "t",
"project": "z8k",
"status": "destroying",
"updated": 211033580760198270
},
{"account": "5k3",
"created": 1655395860833833000,
"description": "this is a more detailed explanation of the resource.",
"identifier": "f",
"name": "resource name",
"org": "t",
"project": "z8k",
"status": "destroying",
"updated": 211033580760198270
}
]

Create workspace

Create a new workspace.

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

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: w2

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": "2",
"version": "cr"
},
"budget": 0.5912672,
"cost_breakdown_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"cost_diff_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"cost_estimation_enabled": true,
"default_pipelines": {"Aperiam ut debitis impedit esse corrupti.": {"project_pipeline": "Accusantium inventore quisquam laborum fugiat a earum.",
"workspace_pipeline": "Et amet animi."
},
"Et nesciunt totam omnis dolor facere qui.": {"project_pipeline": "Accusantium inventore quisquam laborum fugiat a earum.",
"workspace_pipeline": "Et amet animi."
},
"Sed laboriosam voluptate a non eum qui.": {"project_pipeline": "Accusantium inventore quisquam laborum fugiat a earum.",
"workspace_pipeline": "Et amet animi."
}
},
"description": "this is a more detailed explanation of the resource.",
"environment_variables": {"Sed dolore.": {"key": "8",
"value": "Non voluptatum consequatur quia.",
"value_type": "string"
}
},
"identifier": "ef",
"modules_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"name": "resource name",
"provider_connector": "Explicabo aut autem nam laborum facilis.",
"providers_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"provisioner": "terraform",
"provisioner_version": "Sequi et.",
"repository": "Ut vel ut cumque animi et quis.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "At aliquid minus ut et sunt aliquid.",
"repository_path": "",
"repository_sha": "abc10ed",
"repository_submodules": "recursive",
"sparse_checkout": "Sit magnam doloribus.",
"state_checksum": "d21c1662d8ce2c74f24efdc8db93eb34473b86810aeccca4b1518f70b0ccde8f",
"tags": {"foo": "bar"
},
"terraform_plan_json": "f9e21473daaa2674d862b67a1339f4570e86de17",
"terraform_state": "fc1200c7a7aa52109d762a9f005b149abef01479",
"terraform_state_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"terraform_variable_files": [{"repository": "Ut qui dolore aut eum id aut.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Rerum assumenda illum dolores quis ratione sunt.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{"repository": "Ut qui dolore aut eum id aut.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Rerum assumenda illum dolores quis ratione sunt.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{"repository": "Ut qui dolore aut eum id aut.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Rerum assumenda illum dolores quis ratione sunt.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{"repository": "Ut qui dolore aut eum id aut.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Rerum assumenda illum dolores quis ratione sunt.",
"repository_path": "",
"repository_sha": "abc10ed"
}
],
"terraform_variables": {"Porro repellendus aut nesciunt.": {"key": "8",
"value": "Non voluptatum consequatur quia.",
"value_type": "string"
},
"Voluptatem sequi repellat.": {"key": "8",
"value": "Non voluptatum consequatur quia.",
"value_type": "string"
}
},
"variable_sets": ["Odio necessitatibus qui impedit libero.",
"Aut velit."
]
}

Response samples

application/json

{"policy_evaluation": {"account_id": "XRQAjvT37acOiXx9PRaQMF",
"action": "onrun",
"created": 1636370209475,
"details": [{"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [{"deny_messages": ["deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n    \"deny\": [\n        \"deployment stage 'deploy' does not have a HarnessApproval step\"\n    ],\n    \"stages_with_approval\": []\n}",
"policy": {"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{"deny_messages": ["deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n    \"deny\": [\n        \"deployment stage 'deploy' does not have a HarnessApproval step\"\n    ],\n    \"stages_with_approval\": []\n}",
"policy": {"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
},
{"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [{"deny_messages": ["deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n    \"deny\": [\n        \"deployment stage 'deploy' does not have a HarnessApproval step\"\n    ],\n    \"stages_with_approval\": []\n}",
"policy": {"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{"deny_messages": ["deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n    \"deny\": [\n        \"deployment stage 'deploy' does not have a HarnessApproval step\"\n    ],\n    \"stages_with_approval\": []\n}",
"policy": {"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
},
{"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [{"deny_messages": ["deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n    \"deny\": [\n        \"deployment stage 'deploy' does not have a HarnessApproval step\"\n    ],\n    \"stages_with_approval\": []\n}",
"policy": {"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{"deny_messages": ["deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n    \"deny\": [\n        \"deployment stage 'deploy' does not have a HarnessApproval step\"\n    ],\n    \"stages_with_approval\": []\n}",
"policy": {"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
},
{"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: 80
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: tok
identifier required	string [ 1 .. 128 ] characters Identifier is the project identifier. Example: sq

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: ma

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

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: of

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": "9wc",
"associated_template": {"template_id": "t6",
"version": "hq"
},
"backend_locked": true,
"budget": 0.4244252,
"cost_breakdown_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"cost_diff_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"cost_estimation_enabled": true,
"created": 3881737113712192500,
"default_pipelines": {"Dolorum sed tempore libero aut porro mollitia.": {"project_pipeline": "Voluptatem et doloribus minima laboriosam aperiam optio.",
"workspace_pipeline": "Et exercitationem alias sit velit."
}
},
"description": "this is a more detailed explanation of the resource.",
"environment_variables": {"Qui commodi qui explicabo.": {"created": 3533500076040305000,
"key": "b41",
"updated": 8723111932189396000,
"value": "Fugiat expedita tempore.",
"value_type": "string"
}
},
"identifier": "zs",
"modules_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"name": "resource name",
"org": "zl",
"project": "z",
"provider_connector": "Non ullam modi debitis sapiente.",
"providers_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"provisioner": "opentofu",
"provisioner_data": "Atque fuga excepturi.",
"provisioner_version": "Incidunt in adipisci repellendus et.",
"repository": "Ducimus ut.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Perferendis iste iste adipisci et aut ut.",
"repository_path": "",
"repository_sha": "abc10ed",
"repository_submodules": "recursive",
"sparse_checkout": "Aut perspiciatis praesentium.",
"state_checksum": "d21c1662d8ce2c74f24efdc8db93eb34473b86810aeccca4b1518f70b0ccde8f",
"status": "failed",
"tags": {"foo": "bar"
},
"terraform_plan_json": "f9e21473daaa2674d862b67a1339f4570e86de17",
"terraform_state": "fc1200c7a7aa52109d762a9f005b149abef01479",
"terraform_state_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"terraform_variable_files": [{"repository": "Repellat ut.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Aut sunt possimus.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{"repository": "Repellat ut.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Aut sunt possimus.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{"repository": "Repellat ut.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Aut sunt possimus.",
"repository_path": "",
"repository_sha": "abc10ed"
}
],
"terraform_variables": {"Commodi animi iste at qui et corrupti.": {"created": 3533500076040305000,
"key": "b41",
"updated": 8723111932189396000,
"value": "Fugiat expedita tempore.",
"value_type": "string"
},
"Perferendis ut temporibus.": {"created": 3533500076040305000,
"key": "b41",
"updated": 8723111932189396000,
"value": "Fugiat expedita tempore.",
"value_type": "string"
},
"Sit magni.": {"created": 3533500076040305000,
"key": "b41",
"updated": 8723111932189396000,
"value": "Fugiat expedita tempore.",
"value_type": "string"
}
},
"updated": 156953076689056830,
"variable_sets": ["Quo saepe ratione veritatis ut.",
"Quia omnis."
]
}

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

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: zt

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.9948196,
"cost_estimation_enabled": true,
"default_pipelines": {"Fugiat possimus aliquam voluptatem.": {"project_pipeline": "Accusantium inventore quisquam laborum fugiat a earum.",
"workspace_pipeline": "Et amet animi."
}
},
"description": "this is a more detailed explanation of the resource.",
"environment_variables": {"Quaerat reprehenderit sint necessitatibus rem.": {"key": "8",
"value": "Non voluptatum consequatur quia.",
"value_type": "string"
},
"Ratione suscipit.": {"key": "8",
"value": "Non voluptatum consequatur quia.",
"value_type": "string"
},
"Ut animi dolor maxime aut quas.": {"key": "8",
"value": "Non voluptatum consequatur quia.",
"value_type": "string"
}
},
"name": "resource name",
"provider_connector": "Id velit dignissimos.",
"provisioner": "terraform",
"provisioner_version": "Possimus nostrum quisquam.",
"repository": "Exercitationem et aliquid molestias ut ut sit.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Velit sapiente natus et quia quia.",
"repository_path": "",
"repository_sha": "abc10ed",
"repository_submodules": "recursive",
"sparse_checkout": "Qui rerum assumenda.",
"tags": {"foo": "bar"
},
"terraform_variable_files": [{"repository": "Ut qui dolore aut eum id aut.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Rerum assumenda illum dolores quis ratione sunt.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{"repository": "Ut qui dolore aut eum id aut.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Rerum assumenda illum dolores quis ratione sunt.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{"repository": "Ut qui dolore aut eum id aut.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Rerum assumenda illum dolores quis ratione sunt.",
"repository_path": "",
"repository_sha": "abc10ed"
}
],
"terraform_variables": {"A labore qui reprehenderit.": {"key": "8",
"value": "Non voluptatum consequatur quia.",
"value_type": "string"
}
},
"variable_sets": ["Reiciendis similique cumque magnam adipisci vel sed.",
"Magni repudiandae doloremque quia aperiam quis."
]
}

Response samples

application/json

{"policy_evaluation": {"account_id": "XRQAjvT37acOiXx9PRaQMF",
"action": "onrun",
"created": 1636370209475,
"details": [{"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [{"deny_messages": ["deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n    \"deny\": [\n        \"deployment stage 'deploy' does not have a HarnessApproval step\"\n    ],\n    \"stages_with_approval\": []\n}",
"policy": {"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{"deny_messages": ["deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n    \"deny\": [\n        \"deployment stage 'deploy' does not have a HarnessApproval step\"\n    ],\n    \"stages_with_approval\": []\n}",
"policy": {"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
},
{"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [{"deny_messages": ["deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n    \"deny\": [\n        \"deployment stage 'deploy' does not have a HarnessApproval step\"\n    ],\n    \"stages_with_approval\": []\n}",
"policy": {"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{"deny_messages": ["deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n    \"deny\": [\n        \"deployment stage 'deploy' does not have a HarnessApproval step\"\n    ],\n    \"stages_with_approval\": []\n}",
"policy": {"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
},
{"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [{"deny_messages": ["deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n    \"deny\": [\n        \"deployment stage 'deploy' does not have a HarnessApproval step\"\n    ],\n    \"stages_with_approval\": []\n}",
"policy": {"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{"deny_messages": ["deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n    \"deny\": [\n        \"deployment stage 'deploy' does not have a HarnessApproval step\"\n    ],\n    \"stages_with_approval\": []\n}",
"policy": {"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
},
{"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: n7y
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: aa
identifier required	string [ 1 .. 128 ] characters Identifier is the project identifier. Example: tz

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: d0k

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

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: 1

Responses

200

OK response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

get/iacm/api/orgs/{org}/projects/{project}/workspaces/{identifier}/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: 13c
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: 7
identifier required	string [ 1 .. 128 ] characters Identifier is the project identifier. Example: r2

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: 64s

Responses

200

OK response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

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

Request samples

curl
Java
Go

Response samples

application/json

{"outputs": [{"name": "instance_public_ip",
"sensitive": true,
"value": "Aperiam labore exercitationem ab."
},
{"name": "instance_public_ip",
"sensitive": true,
"value": "Aperiam labore exercitationem ab."
}
],
"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: hvh
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: z6q
workspace required	string Example: Et numquam.

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: b

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": "q2",
"name": "resource name"
}

Response samples

application/json

{"policy_evaluation": {"account_id": "XRQAjvT37acOiXx9PRaQMF",
"action": "onrun",
"created": 1636370209475,
"details": [{"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [{"deny_messages": ["deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n    \"deny\": [\n        \"deployment stage 'deploy' does not have a HarnessApproval step\"\n    ],\n    \"stages_with_approval\": []\n}",
"policy": {"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{"deny_messages": ["deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n    \"deny\": [\n        \"deployment stage 'deploy' does not have a HarnessApproval step\"\n    ],\n    \"stages_with_approval\": []\n}",
"policy": {"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
},
{"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [{"deny_messages": ["deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n    \"deny\": [\n        \"deployment stage 'deploy' does not have a HarnessApproval step\"\n    ],\n    \"stages_with_approval\": []\n}",
"policy": {"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{"deny_messages": ["deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n    \"deny\": [\n        \"deployment stage 'deploy' does not have a HarnessApproval step\"\n    ],\n    \"stages_with_approval\": []\n}",
"policy": {"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
},
{"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [{"deny_messages": ["deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n    \"deny\": [\n        \"deployment stage 'deploy' does not have a HarnessApproval step\"\n    ],\n    \"stages_with_approval\": []\n}",
"policy": {"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{"deny_messages": ["deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n    \"deny\": [\n        \"deployment stage 'deploy' does not have a HarnessApproval step\"\n    ],\n    \"stages_with_approval\": []\n}",
"policy": {"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
},
{"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: y9m
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: h
workspace required	string Workspace identifier Example: Qui omnis eum pariatur saepe.

query Parameters

pipeline_execution_id	string Filter by pipeline execution ID Example: pipeline_execution_id=Fugiat consequuntur molestias rerum impedit distinctio eveniet.
pipeline_stage_id	string Filter by pipeline execution stage ID Example: pipeline_stage_id=Sed architecto ut soluta facere eveniet.
provisioner_type	string Filter by provisioner type Example: provisioner_type=Sit aut veniam sint sed possimus quidem.
data_type	string Filter by data type Example: data_type=Nulla perspiciatis alias natus quis blanditiis.
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: tq1

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": "v0",
"created": 7395612051997432000,
"data_type": "cost_breakdown",
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"org": "ndg",
"pipeline_execution_id": "Ab qui voluptas.",
"pipeline_id": "Facilis voluptas placeat.",
"pipeline_stage_id": "Error eveniet similique ea quis est.",
"project": "z",
"provisioner_type": "tf",
"stage_id": "Quisquam reprehenderit est atque fuga accusamus.",
"workspace": "workspace123"
},
{"account": "v0",
"created": 7395612051997432000,
"data_type": "cost_breakdown",
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"org": "ndg",
"pipeline_execution_id": "Ab qui voluptas.",
"pipeline_id": "Facilis voluptas placeat.",
"pipeline_stage_id": "Error eveniet similique ea quis est.",
"project": "z",
"provisioner_type": "tf",
"stage_id": "Quisquam reprehenderit est atque fuga accusamus.",
"workspace": "workspace123"
},
{"account": "v0",
"created": 7395612051997432000,
"data_type": "cost_breakdown",
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"org": "ndg",
"pipeline_execution_id": "Ab qui voluptas.",
"pipeline_id": "Facilis voluptas placeat.",
"pipeline_stage_id": "Error eveniet similique ea quis est.",
"project": "z",
"provisioner_type": "tf",
"stage_id": "Quisquam reprehenderit est atque fuga accusamus.",
"workspace": "workspace123"
},
{"account": "v0",
"created": 7395612051997432000,
"data_type": "cost_breakdown",
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"org": "ndg",
"pipeline_execution_id": "Ab qui voluptas.",
"pipeline_id": "Facilis voluptas placeat.",
"pipeline_stage_id": "Error eveniet similique ea quis est.",
"project": "z",
"provisioner_type": "tf",
"stage_id": "Quisquam reprehenderit est atque fuga accusamus.",
"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: 3
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: 84
workspace required	string Workspace identifier Example: workspace123

query Parameters

pipeline_id required	string The unique identifier for the associated pipeline Example: pipeline_id=Ut non itaque architecto magni id sit.
stage_id required	string The unique identifier for a stage Example: stage_id=Beatae iure nesciunt in consequatur.
pipeline_execution_id required	string The unique identifier for the associated pipeline execution Example: pipeline_execution_id=Dicta facere doloremque sint.
pipeline_stage_id required	string The unique identifier for the associated pipeline execution stage Example: pipeline_stage_id=Eveniet enim deserunt.
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: wo
Content-Length	integer <int64> Size in bytes of the data. Example: 4842080928134952000

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": "Et velit minima aspernatur voluptas earum non.",
"policy_id": "Amet magni.",
"policy_name": "Ea et.",
"policy_set_id": "Eos ut voluptatem.",
"policy_set_name": "Qui magnam et ad fugit.",
"policy_status": "Dignissimos non."
},
{"message": "Et velit minima aspernatur voluptas earum non.",
"policy_id": "Amet magni.",
"policy_name": "Ea et.",
"policy_set_id": "Eos ut voluptatem.",
"policy_set_name": "Qui magnam et ad fugit.",
"policy_status": "Dignissimos non."
},
{"message": "Et velit minima aspernatur voluptas earum non.",
"policy_id": "Amet magni.",
"policy_name": "Ea et.",
"policy_set_id": "Eos ut voluptatem.",
"policy_set_name": "Qui magnam et ad fugit.",
"policy_status": "Dignissimos non."
},
{"message": "Et velit minima aspernatur voluptas earum non.",
"policy_id": "Amet magni.",
"policy_name": "Ea et.",
"policy_set_id": "Eos ut voluptatem.",
"policy_set_name": "Qui magnam et ad fugit.",
"policy_status": "Dignissimos non."
}
],
"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: la
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: 9
workspace required	string Workspace is the resource workspace this variable is associated with. Example: Et accusantium beatae.
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: uj2

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: t3
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: 6
workspace required	string Workspace is the resource workspace this variable is associated with. Example: Et hic dolor autem corrupti neque.
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=Accusantium porro.
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: c

Responses

200

OK response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

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": "Et velit minima aspernatur voluptas earum non.",
"policy_id": "Amet magni.",
"policy_name": "Ea et.",
"policy_set_id": "Eos ut voluptatem.",
"policy_set_name": "Qui magnam et ad fugit.",
"policy_status": "Dignissimos non."
},
{"message": "Et velit minima aspernatur voluptas earum non.",
"policy_id": "Amet magni.",
"policy_name": "Ea et.",
"policy_set_id": "Eos ut voluptatem.",
"policy_set_name": "Qui magnam et ad fugit.",
"policy_status": "Dignissimos non."
},
{"message": "Et velit minima aspernatur voluptas earum non.",
"policy_id": "Amet magni.",
"policy_name": "Ea et.",
"policy_set_id": "Eos ut voluptatem.",
"policy_set_name": "Qui magnam et ad fugit.",
"policy_status": "Dignissimos non."
},
{"message": "Et velit minima aspernatur voluptas earum non.",
"policy_id": "Amet magni.",
"policy_name": "Ea et.",
"policy_set_id": "Eos ut voluptatem.",
"policy_set_name": "Qui magnam et ad fugit.",
"policy_status": "Dignissimos non."
}
],
"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: er
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: ge4
workspace required	string [ 1 .. 1024 ] characters Workspace associated with this event Example: fd

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: 0

Request Body schema: application/json
required

	object
event_type required	string The type of event that occurred Enum: "plan" "drifted" "provisioning" "destroying" "active" "inactive" "failed" "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": {"Dolorum sint.": "Explicabo nulla.",
"Eveniet voluptate sunt.": "Asperiores nostrum."
},
"event_type": "provisioning",
"metadata": {"PlannedChangesCount": 3792597036300497400,
"activity_status": "success",
"activity_type": "apply",
"cost_breakdown_uuid": "Nam reprehenderit mollitia quasi rerum aperiam.",
"cost_currency": "Autem cupiditate sit quo et fugit.",
"cost_diff_total_monthly": "Esse molestiae enim nihil quod deleniti.",
"cost_diff_uuid": "Ea qui quo magnam cupiditate laudantium nostrum.",
"cost_past_total_monthly": "Ut ullam quos sit voluptatum iste.",
"cost_total_monthly": "Cupiditate itaque corrupti eaque laudantium velit.",
"cost_total_monthly_percentage_change": "Perferendis doloribus.",
"drift_counts": {"added": 3521044027668500500,
"changed": 1758244777272374500,
"deleted": 6593554740255922000,
"unchanged": 8813246402021677000
},
"enable_solutions_factory": true,
"git_branch": "Maxime ad et delectus ut soluta.",
"git_commit_message": "Ut ea.",
"git_commit_sha": "Enim ad dolor quam sit maiores.",
"git_repo": "Molestiae expedita.",
"modules_uuid": "Est quo voluptas est.",
"output_counts": {"added": 3521044027668500500,
"changed": 1758244777272374500,
"deleted": 6593554740255922000,
"unchanged": 8813246402021677000
},
"pipeline": "Est eum facilis optio.",
"pipeline_execution_id": "Sit quos ratione facilis laboriosam.",
"pipeline_execution_number": "Ad explicabo quia autem.",
"pipeline_name": "In error voluptate sint architecto necessitatibus suscipit.",
"pipeline_stage_id": "Inventore corrupti sequi consectetur.",
"plan_uuid": "Amet et.",
"providers_uuid": "Corrupti ducimus sed minus qui illo ut.",
"provisioner": "Dolorem dolorum reprehenderit nisi.",
"provisioner_version": "Repellendus delectus quo.",
"resource_counts": {"added": 3521044027668500500,
"changed": 1758244777272374500,
"deleted": 6593554740255922000,
"unchanged": 8813246402021677000
},
"state_checksum": "Atque nam in.",
"state_uuid": "Quas molestias.",
"trigger": {"Iste necessitatibus officia ipsum id.": "Asperiores magnam omnis inventore numquam minima repellendus.",
"Quia qui.": "Et et laudantium."
}
},
"pipeline_execution_id": "Aliquam est distinctio corporis aliquam.",
"pipeline_stage_id": "Illum voluptas earum."
}

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: ni
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: h9v
workspace required	string Workspace identifier Example: Velit dignissimos molestias quia aut voluptas.

query Parameters

limit	integer <int64> [ 1 .. 1000 ] Default: 30 Limit is the number of records to return for a page. Example: limit=30
page	integer <int64> >= 1 Default: 1 Page is the page number to return relative to the page 'limit'. Example: page=1

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: t

Responses

200

OK response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

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

Request samples

curl
Java
Go

Response samples

application/json

{"account": "o",
"org": "bb",
"pipelines": ["Et possimus deserunt ea ut fugit.",
"Maiores quis.",
"Autem molestias est."
],
"project": "ttk"
}

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: 0
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: 2y
workspace required	string The workspace associated with the remote execution. Example: Dolor exercitationem quis.

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: 8aw

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": {"Sed illum quo quasi.": ["Esse quidem ipsam necessitatibus ipsum.",
"Nesciunt consequuntur deleniti est a in commodi.",
"Enim vel aut esse alias."
]
}
}

Response samples

application/json

{"account": "v61",
"created": 5653526842277450000,
"custom_arguments": {"Aut veniam sed voluptatem non temporibus inventore.": ["Porro nam ex.",
"Consequatur dolor facere ipsam ut quod qui."
],
"Sit consequuntur dolores et magni aliquid.": ["Suscipit deserunt exercitationem.",
"Consequatur et reiciendis.",
"In temporibus sit."
]
},
"executed": true,
"id": "ec928250-8bea-4b2e-a718-f60b63e67bdd",
"org": "b",
"pipeline_execution_id": "Qui placeat quidem.",
"pipeline_execution_url": "Explicabo debitis odit hic porro.",
"project": "ts",
"sha256_checksum": "Nostrum molestiae et est porro.",
"updated": 7893269433470947000,
"workspace": "Rem illum accusantium ut voluptate."
}

Show remote execution

Find remote execution

Securityx-api-key

Request

path Parameters

org required	string [ 1 .. 128 ] characters Org is the organisation identifier. Example: 7dn
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: e
workspace required	string Workspace is the resource workspace this variable is associated with. Example: Omnis est fugit cupiditate dolor.
id required	string <uuid> The ID of the remote execution Example: 9409fe96-0d86-4a0f-9986-6849f292747f

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: h

Responses

200

OK response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

get/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/remote-executions/{id}

Request samples

curl
Java
Go

Response samples

application/json

{"account": "vvw",
"created": 9209262826501788000,
"custom_arguments": {"Harum id perferendis.": ["Enim iste modi iste maiores laborum numquam.",
"Dicta nisi dolores."
],
"Ipsum sapiente qui ut fuga minus.": ["Expedita eius.",
"Velit modi omnis mollitia nostrum qui."
],
"Ut fugiat molestiae omnis.": ["Magnam rerum eum ab.",
"Dolor repellendus consequatur earum.",
"Veritatis sapiente libero in."
]
},
"executed": false,
"id": "572443a5-ed34-4428-a516-a43d9b598b74",
"org": "ss",
"pipeline_execution_id": "Saepe labore.",
"pipeline_execution_url": "Assumenda deserunt.",
"project": "iz8",
"sha256_checksum": "Et assumenda explicabo eum fuga.",
"updated": 8121796847450423000,
"workspace": "Rerum cumque et dicta."
}

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: 29
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: 4
workspace required	string Workspace is the resource workspace this variable is associated with. Example: Quia nihil quasi sit dolorum sit.
id required	string <uuid> The ID of the remote execution Example: dbb28a91-91b7-42fc-8d6f-bbb6f09ed7f2

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: 20p

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: c
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: 8jy
workspace required	string Workspace is the resource workspace this variable is associated with. Example: Aut libero dolorum optio sed optio aut.
id required	string <uuid> The ID of the remote execution Example: ba05608b-bea3-48d2-864b-fcc3579ca422

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.

post/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/remote-executions/{id}/execute

Request samples

curl
Java
Go

Response samples

application/json

{"account": "y2",
"created": 887176332694788700,
"custom_arguments": {"Et pariatur praesentium voluptas asperiores facere.": ["Iure optio.",
"Sunt magni reiciendis sapiente aperiam ipsum aperiam."
],
"Magnam accusamus error eius beatae porro harum.": ["Ad cupiditate dolor doloribus.",
"Enim accusantium autem et.",
"Rerum non.",
"Eum qui voluptatum veritatis dolore."
],
"Velit expedita.": ["Dicta maxime dicta excepturi voluptas.",
"Earum hic id sunt doloremque."
]
},
"executed": false,
"id": "950be2c1-4f33-4e66-a2ea-28b07d616a13",
"org": "0qa",
"pipeline_execution_id": "Velit voluptatem dolores id non.",
"pipeline_execution_url": "Molestiae nisi sint.",
"project": "agf",
"sha256_checksum": "Nemo reiciendis.",
"updated": 5129131103844576000,
"workspace": "Porro sapiente rerum vero fugit."
}

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: 9ft
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: s9n
workspace required	string Workspace is the resource workspace this variable is associated with. Example: Itaque et.
id required	string <uuid> The ID of the remote execution Example: dfc8608d-3c6d-46d5-8142-013f79d69f6a

header Parameters

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

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": "dm",
"created": 6529872817684359000,
"custom_arguments": {"Minima sint vel officia et illum ipsum.": ["Minima at voluptatem in aut ut omnis.",
"Et libero fugiat consequatur ea repellendus.",
"Iste repudiandae perferendis aut voluptatibus qui voluptatem."
],
"Quam eveniet sed.": ["Ut sed sequi eos.",
"Ut numquam sed provident."
],
"Totam incidunt explicabo.": ["Voluptate sequi.",
"Rerum aliquid voluptates.",
"Et aspernatur autem."
]
},
"executed": true,
"id": "27f08d54-2d39-4193-a97c-bc79e75c8260",
"org": "sft",
"pipeline_execution_id": "Dolorem consectetur modi.",
"pipeline_execution_url": "Qui aut voluptas.",
"project": "d",
"sha256_checksum": "Voluptatibus et dicta et minima voluptas dolor.",
"updated": 6296628869063078000,
"workspace": "Sequi omnis facilis recusandae earum assumenda."
}

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

query Parameters

org	string [ 1 .. 128 ] characters Organization identifier (required for 'org' and 'project' scope). Example: org=2d
project	string [ 1 .. 128 ] characters Project identifier (required for 'project' scope). Example: project=n
version	string [ 1 .. 32 ] characters Template version associated with the workspace. Example: version=5l

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account identifier.

Example: wb

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": "4q",
"created_at": 1627590400,
"org": "t",
"project": "rfq",
"template_id": "10u",
"updated_at": 1627686800,
"version": "g7o",
"workspace_id": "8h"
},
{"account": "4q",
"created_at": 1627590400,
"org": "t",
"project": "rfq",
"template_id": "10u",
"updated_at": 1627686800,
"version": "g7o",
"workspace_id": "8h"
},
{"account": "4q",
"created_at": 1627590400,
"org": "t",
"project": "rfq",
"template_id": "10u",
"updated_at": 1627686800,
"version": "g7o",
"workspace_id": "8h"
}
]

➔ Next to settings

workspaces

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

path Parameters

query 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