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

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: y1

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

["Sit eligendi.",
"Autem ratione eaque eligendi.",
"Ipsam rem neque."
]

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

query Parameters

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

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: 23

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": {"Consequatur harum voluptas voluptatem sit non eius.": 6196160213110854000,
"Eligendi eligendi sunt nulla quos distinctio enim.": 611862575483109000,
"Qui non doloremque labore dolor non.": 7454580734899437000
}
}

List workspaces

List all workspaces.

Securityx-api-key

Request

path Parameters

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

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=Repellendus perferendis nostrum quidem fuga.&status=Necessitatibus ut ad eum.&status=Illo quidem animi laudantium id.&status=Dolor occaecati.
tags	Array of strings Comma separated list of tags to filter by Example: tags=Rerum minus.&tags=Sit sequi.

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: 7n4

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": "g",
"created": 8360277501748368000,
"description": "this is a more detailed explanation of the resource.",
"identifier": "wm",
"name": "resource name",
"org": "c",
"project": "5u2",
"status": "unknown",
"updated": 272104118471277020
},
{"account": "g",
"created": 8360277501748368000,
"description": "this is a more detailed explanation of the resource.",
"identifier": "wm",
"name": "resource name",
"org": "c",
"project": "5u2",
"status": "unknown",
"updated": 272104118471277020
},
{"account": "g",
"created": 8360277501748368000,
"description": "this is a more detailed explanation of the resource.",
"identifier": "wm",
"name": "resource name",
"org": "c",
"project": "5u2",
"status": "unknown",
"updated": 272104118471277020
}
]

Create workspace

Create a new workspace.

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

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: rue

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 overrides.
description	string Description provides long-form text about the resource.
required	object list of environment variables configured on the workspace.
id	integer <int64> ID PK for internal uses
identifier required	string [ 1 .. 128 ] characters Workspace identifier.
modules_json	string modules_json is the identifier of any modules metadata associated with this workspace
name required	string [ 1 .. 128 ] characters Name is the human readable name for the resource.
provider_connector required	string Provider Connector is the reference to the connector for the infrastructure provider.
	Array of objects (WorkspaceProviderConnector) define an array of provider connectors that belong to Workspace
providers_json	string providers_json is the identifier of any modules metadata associated with this workspace
provisioner required	string Provisioner defines the provisioning tool to use.
provisioner_version	string Default: "latest" Provisioner Version defines the tool version to use.
prune_sensitive_data	boolean Default: false prune_sensitive_data is a flag to enable or disable pruning of sensitive data
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"
run_all	boolean Run-All terragrunt modules.
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 only 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.
terragrunt_provider	boolean Default: false Whether this workspace uses terragrunt to provision infrastructure
terragrunt_version	string Terragrunt Version to use when provisioner is terragrunt.
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": "q0",
"version": "2hu"
},
"budget": 0.8490217,
"cost_breakdown_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"cost_diff_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"cost_estimation_enabled": true,
"default_pipelines": {"Tempore dolorem velit vel occaecati.": {"project_pipeline": "Tenetur quis libero.",
"workspace_pipeline": "Quas facere ipsa consequuntur."
}
},
"description": "this is a more detailed explanation of the resource.",
"environment_variables": {"Et sapiente et quod a repudiandae amet.": {"key": "a1",
"value": "Ad iure ex asperiores libero.",
"value_type": "secret"
}
},
"id": 802131525631891200,
"identifier": "32s",
"modules_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"name": "resource name",
"provider_connector": "Nemo quidem.",
"provider_connectors": [{"connector_ref": "3va",
"created": 1627590400,
"id": 1219232998228301800,
"terragrunt_provider": true,
"type": "azure",
"updated": 1627686800,
"workspace_id": 7133809002535258000
},
{"connector_ref": "3va",
"created": 1627590400,
"id": 1219232998228301800,
"terragrunt_provider": true,
"type": "azure",
"updated": 1627686800,
"workspace_id": 7133809002535258000
},
{"connector_ref": "3va",
"created": 1627590400,
"id": 1219232998228301800,
"terragrunt_provider": true,
"type": "azure",
"updated": 1627686800,
"workspace_id": 7133809002535258000
},
{"connector_ref": "3va",
"created": 1627590400,
"id": 1219232998228301800,
"terragrunt_provider": true,
"type": "azure",
"updated": 1627686800,
"workspace_id": 7133809002535258000
}
],
"providers_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"provisioner": "Quo consequatur.",
"provisioner_version": "Magni ab tempora.",
"prune_sensitive_data": true,
"repository": "Molestias eos recusandae quaerat est aperiam dolorum.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Beatae assumenda et beatae sit.",
"repository_path": "",
"repository_sha": "abc10ed",
"repository_submodules": "recursive",
"run_all": false,
"sparse_checkout": "Iure nostrum.",
"state_checksum": "d21c1662d8ce2c74f24efdc8db93eb34473b86810aeccca4b1518f70b0ccde8f",
"tags": {"foo": "bar"
},
"terraform_plan_json": "f9e21473daaa2674d862b67a1339f4570e86de17",
"terraform_state": "fc1200c7a7aa52109d762a9f005b149abef01479",
"terraform_state_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"terraform_variable_files": [{"repository": "Voluptate omnis minima laboriosam qui eos.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Eos natus quia suscipit nostrum ea et.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{"repository": "Voluptate omnis minima laboriosam qui eos.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Eos natus quia suscipit nostrum ea et.",
"repository_path": "",
"repository_sha": "abc10ed"
}
],
"terraform_variables": {"Maiores natus ea fugit.": {"key": "a1",
"value": "Ad iure ex asperiores libero.",
"value_type": "secret"
},
"Quis qui.": {"key": "a1",
"value": "Ad iure ex asperiores libero.",
"value_type": "secret"
}
},
"terragrunt_provider": false,
"terragrunt_version": "Sint dolorum.",
"variable_sets": ["Ullam consequatur id.",
"Adipisci ea.",
"A fugit ut quidem explicabo doloremque pariatur.",
"Voluptatem dolor soluta quaerat ea nemo."
]
}

Response samples

application/json

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

Destroy workspace

Deletes the given workspace.

Securityx-api-key

Request

path Parameters

org required	string [ 1 .. 128 ] characters Org is the organisation identifier. Example: vcp
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: 0k1
identifier required	string [ 1 .. 128 ] characters Identifier is the project identifier. Example: v

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: 726

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

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: aqw

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": "po",
"associated_template": {"template_id": "3nl",
"version": "t"
},
"backend_locked": true,
"budget": 0.91971445,
"cost_breakdown_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"cost_diff_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"cost_estimation_enabled": true,
"created": 914833002181738200,
"default_pipelines": {"Voluptatem et omnis quo.": {"project_pipeline": "Blanditiis provident atque aut.",
"workspace_pipeline": "Quo omnis aut facere."
}
},
"description": "this is a more detailed explanation of the resource.",
"environment_variables": {"Esse porro alias dolorem.": {"created": 188313336339995970,
"key": "ehp",
"updated": 8417673460528250000,
"value": "Iusto numquam voluptatem.",
"value_type": "string"
},
"Non fugiat.": {"created": 188313336339995970,
"key": "ehp",
"updated": 8417673460528250000,
"value": "Iusto numquam voluptatem.",
"value_type": "string"
}
},
"identifier": "cau",
"modules_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"name": "resource name",
"org": "swd",
"project": "qf",
"provider_connector": "Ipsam deserunt alias commodi natus vel.",
"provider_connectors": [{"connector_ref": "s",
"created": 1627590400,
"id": 559326760424070460,
"terragrunt_provider": false,
"type": "aws",
"updated": 1627686800,
"workspace_id": 5139016603692465000
},
{"connector_ref": "s",
"created": 1627590400,
"id": 559326760424070460,
"terragrunt_provider": false,
"type": "aws",
"updated": 1627686800,
"workspace_id": 5139016603692465000
},
{"connector_ref": "s",
"created": 1627590400,
"id": 559326760424070460,
"terragrunt_provider": false,
"type": "aws",
"updated": 1627686800,
"workspace_id": 5139016603692465000
}
],
"providers_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"provisioner": "Accusamus ipsam autem ut.",
"provisioner_data": "Facilis tempore illum voluptatum itaque.",
"provisioner_version": "Ratione est.",
"prune_sensitive_data": true,
"repository": "Commodi ut qui.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Laboriosam cum saepe exercitationem.",
"repository_path": "",
"repository_sha": "abc10ed",
"repository_submodules": "recursive",
"run_all": false,
"sparse_checkout": "Nulla recusandae consequuntur nisi eius facilis aut.",
"state_checksum": "d21c1662d8ce2c74f24efdc8db93eb34473b86810aeccca4b1518f70b0ccde8f",
"status": "unknown",
"tags": {"foo": "bar"
},
"terraform_plan_json": "f9e21473daaa2674d862b67a1339f4570e86de17",
"terraform_state": "fc1200c7a7aa52109d762a9f005b149abef01479",
"terraform_state_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"terraform_variable_files": [{"repository": "Culpa ut saepe sit rerum sit sunt.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Ea ut et nihil magni dolor deleniti.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{"repository": "Culpa ut saepe sit rerum sit sunt.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Ea ut et nihil magni dolor deleniti.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{"repository": "Culpa ut saepe sit rerum sit sunt.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Ea ut et nihil magni dolor deleniti.",
"repository_path": "",
"repository_sha": "abc10ed"
}
],
"terraform_variables": {"Dolorum itaque inventore quisquam eos tempore amet.": {"created": 188313336339995970,
"key": "ehp",
"updated": 8417673460528250000,
"value": "Iusto numquam voluptatem.",
"value_type": "string"
},
"Molestias quisquam vel eum accusantium.": {"created": 188313336339995970,
"key": "ehp",
"updated": 8417673460528250000,
"value": "Iusto numquam voluptatem.",
"value_type": "string"
},
"Nihil quas est aspernatur illo qui non.": {"created": 188313336339995970,
"key": "ehp",
"updated": 8417673460528250000,
"value": "Iusto numquam voluptatem.",
"value_type": "string"
}
},
"terragrunt_provider": true,
"terragrunt_version": "Occaecati aut repellendus deserunt ullam.",
"updated": 4758892555209879000,
"variable_sets": ["Dolores voluptate.",
"Quia qui assumenda repellat provident animi repellendus.",
"Fugiat quam cupiditate sed eaque."
]
}

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

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: z3

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 overrides.
description	string Description provides long-form text about the resource.
required	object list of environment variables configured on the workspace.
name required	string [ 1 .. 128 ] characters Name is the human readable name for the resource.
provider_connector required	string Provider Connector is the reference to the connector for the infrastructure provider.
	Array of objects (WorkspaceProviderConnector) define an array of provider connectors that belong to Workspace
provisioner required	string Provisioner defines the provisioning tool to use.
provisioner_version	string Default: "latest" Provisioner Version defines the tool version to use.
prune_sensitive_data	boolean Default: false prune_sensitive_data is a flag to enable or disable pruning of sensitive data
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"
run_all	boolean Run-All terragrunt modules.
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.
terragrunt_provider	boolean Default: false Whether this workspace uses terragrunt to provision infrastructure
terragrunt_version	string Terragrunt Version to use when provisioner is terragrunt.
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.5072158,
"cost_estimation_enabled": true,
"default_pipelines": {"Occaecati minima quisquam suscipit non porro.": {"project_pipeline": "Tenetur quis libero.",
"workspace_pipeline": "Quas facere ipsa consequuntur."
}
},
"description": "this is a more detailed explanation of the resource.",
"environment_variables": {"Fugiat ut assumenda.": {"key": "a1",
"value": "Ad iure ex asperiores libero.",
"value_type": "secret"
},
"Quidem similique quo.": {"key": "a1",
"value": "Ad iure ex asperiores libero.",
"value_type": "secret"
}
},
"name": "resource name",
"provider_connector": "Quisquam dolor sed.",
"provider_connectors": [{"connector_ref": "3va",
"created": 1627590400,
"id": 1219232998228301800,
"terragrunt_provider": true,
"type": "azure",
"updated": 1627686800,
"workspace_id": 7133809002535258000
},
{"connector_ref": "3va",
"created": 1627590400,
"id": 1219232998228301800,
"terragrunt_provider": true,
"type": "azure",
"updated": 1627686800,
"workspace_id": 7133809002535258000
},
{"connector_ref": "3va",
"created": 1627590400,
"id": 1219232998228301800,
"terragrunt_provider": true,
"type": "azure",
"updated": 1627686800,
"workspace_id": 7133809002535258000
}
],
"provisioner": "Illo non animi.",
"provisioner_version": "Aspernatur alias quidem ab tempora sed omnis.",
"prune_sensitive_data": true,
"repository": "Ipsam incidunt laboriosam.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Quod aut facilis.",
"repository_path": "",
"repository_sha": "abc10ed",
"repository_submodules": "recursive",
"run_all": false,
"sparse_checkout": "Doloribus laborum.",
"tags": {"foo": "bar"
},
"terraform_variable_files": [{"repository": "Voluptate omnis minima laboriosam qui eos.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Eos natus quia suscipit nostrum ea et.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{"repository": "Voluptate omnis minima laboriosam qui eos.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Eos natus quia suscipit nostrum ea et.",
"repository_path": "",
"repository_sha": "abc10ed"
}
],
"terraform_variables": {"Aut ut officiis aut.": {"key": "a1",
"value": "Ad iure ex asperiores libero.",
"value_type": "secret"
},
"Cupiditate molestias aut dignissimos aut dolorum.": {"key": "a1",
"value": "Ad iure ex asperiores libero.",
"value_type": "secret"
},
"Eum qui veritatis cumque assumenda.": {"key": "a1",
"value": "Ad iure ex asperiores libero.",
"value_type": "secret"
}
},
"terragrunt_provider": true,
"terragrunt_version": "Tempore voluptatum earum iure.",
"variable_sets": ["Saepe perferendis atque ea quasi in cumque.",
"Eum labore iusto iure ut aut."
]
}

Response samples

application/json

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

Force unlock workspace

Force unlock a workspace.

Securityx-api-key

Request

path Parameters

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

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: k97

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

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: wl

Responses

200

OK response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

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

Request samples

curl
Java
Go

Response samples

application/json

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

List resources

List resources associated with this workspace.

Securityx-api-key

Request

path Parameters

org required	string [ 1 .. 128 ] characters Org is the organisation identifier. Example: d
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: fk
identifier required	string [ 1 .. 128 ] characters Workspace identifier. Example: o

query Parameters

resource_types

Array of strings

Resource types to filter by.

Example: resource_types=aws_instance&resource_types=google_compute_instance

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: x

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": "Sit quis ullam aut est qui minus."
},
{"name": "instance_public_ip",
"sensitive": true,
"value": "Sit quis ullam aut est qui minus."
}
],
"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"
}
]
}

List resources using selectors

List resources for a workspace using selectors.

Securityx-api-key

Request

path Parameters

org required	string [ 1 .. 128 ] characters Org is the organisation identifier. Example: 9l
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: 7bo
identifier required	string Workspace identifier Example: Ipsam ullam.

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: hjq

Request Body schema: application/json
required

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

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}/resources/search

Request samples

Payload
curl
Java
Go

application/json

{"limit": 30,
"page": 1,
"selectors": [{"include_conditions": [{"attribute": "tag.environment",
"operator": "equals",
"value": "prod"
}
],
"resource_type": "aws_instance"
},
{"include_conditions": [{"attribute": "tag.environment",
"operator": "equals",
"value": "prod"
}
],
"resource_type": "aws_instance"
},
{"include_conditions": [{"attribute": "tag.environment",
"operator": "equals",
"value": "prod"
}
],
"resource_type": "aws_instance"
},
{"include_conditions": [{"attribute": "tag.environment",
"operator": "equals",
"value": "prod"
}
],
"resource_type": "aws_instance"
}
]
}

Response samples

application/json

[{"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: y8
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: uo
workspace required	string Example: Sit adipisci qui.

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: ax2

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

Response samples

application/json

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

List data

List all stored data for a workspace.

Securityx-api-key

Request

path Parameters

org required	string [ 1 .. 128 ] characters Org is the organisation identifier. Example: 1n
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: p
workspace required	string Workspace identifier Example: Est et dolorem.

query Parameters

pipeline_execution_id	string Filter by pipeline execution ID Example: pipeline_execution_id=Et qui aliquid sed.
pipeline_stage_id	string Filter by pipeline execution stage ID Example: pipeline_stage_id=Aperiam perferendis assumenda id quaerat.
provisioner_type	string Filter by provisioner type Example: provisioner_type=Corporis placeat optio.
data_type	string Filter by data type Example: data_type=Eligendi fuga assumenda velit deserunt.
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: s

Responses

200

OK response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

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

Request samples

curl
Java
Go

Response samples

application/json

[{"account": "9dp",
"created": 6874213526855861000,
"data_type": "providers",
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"org": "l",
"pipeline_execution_id": "Voluptatem voluptas reiciendis itaque aut et.",
"pipeline_id": "Tempore nulla ut et qui et amet.",
"pipeline_stage_id": "Tempora sit ex perferendis aut animi laborum.",
"project": "19r",
"provisioner_type": "tf",
"stage_id": "Assumenda eveniet.",
"workspace": "workspace123"
},
{"account": "9dp",
"created": 6874213526855861000,
"data_type": "providers",
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"org": "l",
"pipeline_execution_id": "Voluptatem voluptas reiciendis itaque aut et.",
"pipeline_id": "Tempore nulla ut et qui et amet.",
"pipeline_stage_id": "Tempora sit ex perferendis aut animi laborum.",
"project": "19r",
"provisioner_type": "tf",
"stage_id": "Assumenda eveniet.",
"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: 8
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: mhi
workspace required	string Workspace identifier Example: workspace123

query Parameters

pipeline_id required	string The unique identifier for the associated pipeline Example: pipeline_id=Eius corrupti voluptates nam rem.
stage_id required	string The unique identifier for a stage Example: stage_id=Libero eveniet fuga quam.
pipeline_execution_id required	string The unique identifier for the associated pipeline execution Example: pipeline_execution_id=Minima itaque.
pipeline_stage_id required	string The unique identifier for the associated pipeline execution stage Example: pipeline_stage_id=Minus delectus in velit ad.
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_breakdown
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: 7
Content-Length	integer <int64> Size in bytes of the data. Example: 6198533961816563000

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": "Quia eum et debitis sint ducimus.",
"policy_id": "Autem et et tenetur occaecati.",
"policy_name": "Error dolores neque voluptatum.",
"policy_set_id": "Iusto qui sit dolore quia recusandae.",
"policy_set_name": "A sint.",
"policy_status": "Eos et esse ex qui blanditiis quo."
},
{"message": "Quia eum et debitis sint ducimus.",
"policy_id": "Autem et et tenetur occaecati.",
"policy_name": "Error dolores neque voluptatum.",
"policy_set_id": "Iusto qui sit dolore quia recusandae.",
"policy_set_name": "A sint.",
"policy_status": "Eos et esse ex qui blanditiis quo."
},
{"message": "Quia eum et debitis sint ducimus.",
"policy_id": "Autem et et tenetur occaecati.",
"policy_name": "Error dolores neque voluptatum.",
"policy_set_id": "Iusto qui sit dolore quia recusandae.",
"policy_set_name": "A sint.",
"policy_status": "Eos et esse ex qui blanditiis quo."
},
{"message": "Quia eum et debitis sint ducimus.",
"policy_id": "Autem et et tenetur occaecati.",
"policy_name": "Error dolores neque voluptatum.",
"policy_set_id": "Iusto qui sit dolore quia recusandae.",
"policy_set_name": "A sint.",
"policy_status": "Eos et esse ex qui blanditiis quo."
}
],
"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: t4
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: l8
workspace required	string Workspace is the resource workspace this variable is associated with. Example: Ut iure voluptas saepe dolor sit ducimus.
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: bnh

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: m9j
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: gh
workspace required	string Workspace is the resource workspace this variable is associated with. Example: Vel provident sed.
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=Corporis nulla libero nihil.
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: t

Responses

200

OK response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

get/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/data/{id}/evaluate-policy

Request samples

curl
Java
Go

Response samples

application/json

{"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"policy_evaluation": [{"message": "Quia eum et debitis sint ducimus.",
"policy_id": "Autem et et tenetur occaecati.",
"policy_name": "Error dolores neque voluptatum.",
"policy_set_id": "Iusto qui sit dolore quia recusandae.",
"policy_set_name": "A sint.",
"policy_status": "Eos et esse ex qui blanditiis quo."
},
{"message": "Quia eum et debitis sint ducimus.",
"policy_id": "Autem et et tenetur occaecati.",
"policy_name": "Error dolores neque voluptatum.",
"policy_set_id": "Iusto qui sit dolore quia recusandae.",
"policy_set_name": "A sint.",
"policy_status": "Eos et esse ex qui blanditiis quo."
},
{"message": "Quia eum et debitis sint ducimus.",
"policy_id": "Autem et et tenetur occaecati.",
"policy_name": "Error dolores neque voluptatum.",
"policy_set_id": "Iusto qui sit dolore quia recusandae.",
"policy_set_name": "A sint.",
"policy_status": "Eos et esse ex qui blanditiis quo."
}
],
"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: k
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: kf6
workspace required	string [ 1 .. 1024 ] characters Workspace associated with this event Example: sl4

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: l

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": {"Facere laboriosam et.": "Eaque accusantium ea quo quae unde.",
"Laudantium quibusdam voluptatem illum rerum voluptatem non.": "Fuga ipsum."
},
"event_type": "stage-complete",
"metadata": {"PlannedChangesCount": 1564896385827558700,
"activity_status": "success",
"activity_type": "import",
"cost_breakdown_uuid": "Voluptatibus voluptatem a.",
"cost_currency": "Cum quo.",
"cost_diff_total_monthly": "Aut sed rerum voluptatibus quidem velit.",
"cost_diff_uuid": "Non accusantium et sunt quasi dolor.",
"cost_past_total_monthly": "Autem commodi natus modi veritatis est.",
"cost_total_monthly": "Placeat odit cum et.",
"cost_total_monthly_percentage_change": "Et praesentium.",
"drift_counts": {"added": 8991425374433659000,
"changed": 113553894264113700,
"deleted": 2258726041729259000,
"imported": 913953750339561100,
"removed": 5209011678468686000,
"unchanged": 6875716529476673000
},
"enable_solutions_factory": false,
"git_branch": "Quo dolores sapiente totam.",
"git_commit_message": "Itaque ut vel pariatur tenetur.",
"git_commit_sha": "Dignissimos laborum.",
"git_repo": "Reprehenderit voluptatibus optio est sed inventore voluptatem.",
"modules_uuid": "Laudantium nobis maiores non occaecati quia.",
"output_counts": {"added": 8991425374433659000,
"changed": 113553894264113700,
"deleted": 2258726041729259000,
"imported": 913953750339561100,
"removed": 5209011678468686000,
"unchanged": 6875716529476673000
},
"pipeline": "Sed saepe.",
"pipeline_execution_id": "Deleniti numquam et ea unde ut illo.",
"pipeline_execution_number": "Neque illum quod error consequatur cumque nihil.",
"pipeline_name": "Laborum eos magnam sed et et.",
"pipeline_stage_id": "Magnam laboriosam omnis voluptatem itaque vero.",
"plan_uuid": "Et ex.",
"providers_uuid": "Nulla consequuntur voluptatibus ducimus.",
"provisioner": "Tempore consequatur voluptatem voluptatum et.",
"provisioner_version": "Necessitatibus ut rerum deserunt error reprehenderit.",
"resource_counts": {"added": 8991425374433659000,
"changed": 113553894264113700,
"deleted": 2258726041729259000,
"imported": 913953750339561100,
"removed": 5209011678468686000,
"unchanged": 6875716529476673000
},
"state_checksum": "Sit et.",
"state_uuid": "Eius autem.",
"trigger": {"Minus neque et earum dolores neque.": "Qui velit eaque nesciunt tempora nesciunt nam."
}
},
"pipeline_execution_id": "Cum rerum iste qui qui commodi.",
"pipeline_stage_id": "Quisquam animi non reiciendis sit deserunt."
}

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: 0
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: 54w
workspace required	string Workspace identifier Example: Ut ut dolor aliquid non voluptatibus.

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

Responses

200

OK response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

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

Request samples

curl
Java
Go

Response samples

application/json

{"account": "w",
"org": "3bl",
"pipelines": ["Porro tempora.",
"Minima nisi qui aspernatur voluptatem voluptate est."
],
"project": "8be"
}

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: v
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: cm5
workspace required	string The workspace associated with the remote execution. Example: Sint illo architecto temporibus.

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: r

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": {"Cupiditate modi ut aut ullam officia tenetur.": ["Eos voluptatibus doloremque perferendis.",
"Culpa quia repudiandae modi.",
"Aspernatur nihil laborum voluptas architecto eum."
],
"In ut nulla aut et vero.": ["Amet sint natus sint quos enim.",
"Est maiores quibusdam aliquid."
],
"Quia sit et eligendi et sit.": ["Adipisci et quod officiis et.",
"Quia numquam nihil dolor.",
"Praesentium dolorum explicabo pariatur maxime omnis qui."
]
}
}

Response samples

application/json

{"account": "yfh",
"created": 1318587545902807600,
"custom_arguments": {"Qui ipsam.": ["Aut alias vel est ea modi quas.",
"Cumque incidunt fuga consequatur odio.",
"Ut velit sit porro sed."
]
},
"executed": false,
"id": "c6e343d2-685a-4d91-8da4-d17dce5b6015",
"org": "ck",
"pipeline_execution_id": "Minus aut unde dolorem commodi exercitationem.",
"pipeline_execution_url": "Deleniti sint aliquam qui.",
"project": "rxs",
"sha256_checksum": "Ratione ipsam est qui.",
"updated": 4641665795756345000,
"workspace": "Eligendi ab deleniti et quia enim quibusdam."
}

Show remote execution

Find remote execution

Securityx-api-key

Request

path Parameters

org required	string [ 1 .. 128 ] characters Org is the organisation identifier. Example: 168
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: y
workspace required	string Workspace is the resource workspace this variable is associated with. Example: Tempora dolores sit animi iure blanditiis.
id required	string <uuid> The ID of the remote execution Example: 923c5dba-f856-4387-aa2e-31163f80c375

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: dct

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": "s",
"created": 5846184400883632000,
"custom_arguments": {"Voluptas ipsam harum consequuntur voluptatibus ut.": ["Reiciendis harum minima laboriosam velit accusantium sed.",
"Reprehenderit qui et.",
"Veritatis amet voluptatum a.",
"Corporis exercitationem laboriosam voluptate natus qui voluptas."
]
},
"executed": false,
"id": "ba4ca104-d592-49b0-b19e-ce91ce47b7e5",
"org": "up",
"pipeline_execution_id": "Quisquam et in aut iusto ipsum.",
"pipeline_execution_url": "Officia quidem.",
"project": "jm",
"sha256_checksum": "Cupiditate aut.",
"updated": 2925468222543709700,
"workspace": "Occaecati voluptates explicabo unde adipisci praesentium dolorem."
}

Download remote execution

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: y
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: j
workspace required	string Workspace is the resource workspace this variable is associated with. Example: Omnis maiores autem consectetur sapiente rerum.
id required	string <uuid> The ID of the remote execution Example: ca73e6f0-d333-4fb6-b803-2df40d72cca0

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: fm

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: a2g
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: y
workspace required	string Workspace is the resource workspace this variable is associated with. Example: Facere architecto neque et maiores ut.
id required	string <uuid> The ID of the remote execution Example: c7acad87-21f9-4d50-92d6-24ca4ef325a3

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: sn5

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": "l",
"created": 4464042538801969000,
"custom_arguments": {"Sint asperiores qui id.": ["Eum aliquid ratione repellendus sit atque.",
"Ut sit minima eos est laboriosam.",
"Molestiae officia adipisci consequuntur et architecto.",
"Commodi placeat veritatis."
]
},
"executed": false,
"id": "3790fd30-98a9-4722-9d86-60cbfb2803cd",
"org": "gm",
"pipeline_execution_id": "Nisi sit dolorem aut animi magni.",
"pipeline_execution_url": "Quae dicta dolores expedita facere maxime amet.",
"project": "zf",
"sha256_checksum": "Quo quasi recusandae quaerat aut.",
"updated": 7809216171335552000,
"workspace": "Temporibus debitis."
}

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: h0
project required	string [ 1 .. 128 ] characters Project is the project identifier. Example: f
workspace required	string Workspace is the resource workspace this variable is associated with. Example: Consectetur earum reprehenderit omnis odit id non.
id required	string <uuid> The ID of the remote execution Example: 21d38853-df27-4e8b-866a-0088439924cb

header Parameters

Harness-Account required	string [ 1 .. 128 ] characters Account is the internal customer account ID. Example: yi
Content-Length	integer <int64> Size in bytes of the source code. Example: 3860330988925239000
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: Cum aperiam voluptate excepturi.

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": "4c",
"created": 5255090707618725000,
"custom_arguments": {"Natus illum.": ["Vel ut deleniti.",
"Inventore non.",
"Odio voluptatem fugiat.",
"Totam vitae consequatur beatae."
]
},
"executed": false,
"id": "5e4ed888-8448-43ff-960a-95df01e1f215",
"org": "ve",
"pipeline_execution_id": "Id tenetur minima reiciendis aliquam sit est.",
"pipeline_execution_url": "Veniam veniam sapiente beatae voluptas molestias modi.",
"project": "ars",
"sha256_checksum": "Id sed placeat est rerum laboriosam.",
"updated": 2833096911449527300,
"workspace": "Esse corrupti beatae exercitationem recusandae aspernatur."
}

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

query Parameters

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

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: g

Responses

200

OK response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

get/iacm/api/orgs/{org}/projects/{project}/workspaces/provisioners-ratio

Request samples

curl
Java
Go

Response samples

application/json

{"provisioner": {"Est praesentium impedit corrupti est ut.": 0.27619197192658046,
"Sit quod odio porro.": 0.8531117606487337
},
"total": 0.6876921519832563
}

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

query Parameters

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

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account identifier.

Example: k

Responses

200

OK response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

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

Request samples

curl
Java
Go

Response samples

application/json

[{"account": "x",
"created_at": 1627590400,
"org": "us",
"project": "m",
"template_id": "oq",
"updated_at": 1627686800,
"version": "uen",
"workspace_id": "xfx"
},
{"account": "x",
"created_at": 1627590400,
"org": "us",
"project": "m",
"template_id": "oq",
"updated_at": 1627686800,
"version": "uen",
"workspace_id": "xfx"
},
{"account": "x",
"created_at": 1627590400,
"org": "us",
"project": "m",
"template_id": "oq",
"updated_at": 1627686800,
"version": "uen",
"workspace_id": "xfx"
}
]

➔ Next to settings

workspaces

List all workspace tags

path Parameters

header Parameters

Show workspace metrics

path Parameters

query Parameters

header Parameters

List workspaces

path Parameters

query Parameters

header Parameters

Create workspace

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Destroy workspace

path Parameters

header Parameters

Show workspace

path Parameters

header Parameters

Update workspace

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Force unlock workspace

path Parameters

header Parameters

List modules

path Parameters

header Parameters

List resources

path Parameters

query Parameters

header Parameters

List resources using selectors

path Parameters

header Parameters

Request Body schema: application/jsonrequired

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 execution

path Parameters

header Parameters

execute-remote-execution workspaces

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

Request Body schema: application/json
required