Workspaces
Workspaces Service handles the API for managing workspaces and triggering workflows against them.
List all tags
Org is the organisation identifier.
pgProject is the project identifier.
fc9Account is the internal customer account ID.
lOK response.
["Explicabo porro aut et aliquid.","At est debitis.","Doloribus tempora nemo inventore consequatur porro.","Atque veniam ea id."]BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/tags HTTP/1.1
Host: localhost:80
Harness-Account: l
Accept: */*
[
"Eius deserunt qui aut quasi dolores.",
"Minus aut rerum facilis laboriosam accusamus enim."
]Show metrics for workspaces
Org is the organisation identifier.
xgProject is the project identifier.
lvoStart time filter (Unix timestamp)
2454094628947063000End time filter (Unix timestamp)
2086969625371467500Account is the internal customer account ID.
seOK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/workspace-metrics HTTP/1.1
Host: localhost:80
Harness-Account: se
Accept: */*
{
"status_counts": {
"Ab debitis quam qui.": 3364157374848411000,
"Deleniti quisquam.": 8552386470240735000,
"Suscipit et qui.": 119343305104830880
}
}List all workspaces.
Org is the organisation identifier.
v9Project is the project identifier.
kLimit is the number of records to return for a page.
30Example: 30Page is the page number to return relative to the page 'limit'.
1Example: 1Filter results by partial name match
""Example: mystaSort order for results
name,ASCExample: name,ASCPossible values: Status of the execution
["Ipsa earum error optio.","Error animi soluta voluptatibus laudantium voluptate dolore.","Nemo delectus suscipit facilis iusto.","Natus aliquid deserunt explicabo voluptatem ex."]Comma separated list of tags to filter by
["Commodi et repellendus aliquid.","Sunt voluptas est placeat.","Iusto nihil nemo."]Account is the internal customer account ID.
7OK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/workspaces HTTP/1.1
Host: localhost:80
Harness-Account: 7
Accept: */*
[
{
"account": "svj",
"created": 3074050882718802000,
"description": "this is a more detailed explanation of the resource.",
"identifier": "63",
"name": "resource name",
"org": "g",
"project": "ur",
"status": "destroying",
"updated": 8290525425254425000
},
{
"account": "svj",
"created": 3074050882718802000,
"description": "this is a more detailed explanation of the resource.",
"identifier": "63",
"name": "resource name",
"org": "g",
"project": "ur",
"status": "destroying",
"updated": 8290525425254425000
}
]Create a new workspace.
Org is the organisation identifier.
gProject is the project identifier.
vAccount is the internal customer account ID.
z26define the budget for a specific workspace
0.5187297define if CCM cost integration is enabled for this workspace
falseExample: falsecost_breakdown_json is the identifier to the breakdown cost file from the current execution that was applied successfully
c4a2d99bc28d236098a095277b7eb0718d6be068cost_diff_json is the identifier to the diff cost file between the previous and current successful executions
c4a2d99bc28d236098a095277b7eb0718d6be068define if cost estimation operations will be performed in this workspace
falseExample: trueif true, auto-generate default pipelines for the workspace provisioner at creation time
trueExample: falseDescription provides long-form text about the resource.
this is a more detailed explanation of the resource.ID PK for internal uses
5797109307449759000Workspace identifier.
miymodules_json is the identifier of any modules metadata associated with this workspace
c4a2d99bc28d236098a095277b7eb0718d6be068Name is the human readable name for the resource.
resource nameProvider Connector is the reference to the connector for the infrastructure provider.
Optio blanditiis eum mollitia excepturi voluptatem nesciunt.providers_json is the identifier of any modules metadata associated with this workspace
c4a2d99bc28d236098a095277b7eb0718d6be068Provisioner defines the provisioning tool to use.
Velit ab quidem a.Provisioner configuration metadata (key value pair provisioner specific configuration).
Dolorem fuga.Provisioner Version defines the tool version to use.
latestExample: Rerum nihil fugiat.prune_sensitive_data is a flag to enable or disable pruning of sensitive data
falseExample: trueRepository is the name of the repository to use.
Doloremque qui maxime est.Repository Branch in which the code should be accessed.
mainRepository Commit/Tag in which the code should be accessed.
abc10edRepository Connector is the reference to the connector to use for this code.
Quia consequatur unde architecto enim velit aspernatur.Repository Path is the path in which the infra code resides.
""Repository SHA in which the code should be accessed.
abc10edrepository_submodules is the instruction about whether to clone submodules in the pipeline step
falseExample: recursivePossible values: Run-All terragrunt modules.
trueList of patterens that will be used for sparse checkout option of git clone
Perferendis ut dolorem magnam.state_checksum is the sha-256 checksum of terraform state file
d21c1662d8ce2c74f24efdc8db93eb34473b86810aeccca4b1518f70b0ccde8fterraform_plan_json is the identifier to the current state file only in JSON format.
f9e21473daaa2674d862b67a1339f4570e86de17terraform_state is the identifier to the plan file used to create the latest state.
fc1200c7a7aa52109d762a9f005b149abef01479terraform_state_json is the identifier to the plan file used to create the latest state only in JSON format.
c4a2d99bc28d236098a095277b7eb0718d6be068Whether this workspace uses terragrunt to provision infrastructure
falseExample: trueTerragrunt Version to use when provisioner is terragrunt.
Qui adipisci quia autem itaque.Attached Variable Sets references
["Nam delectus architecto consequatur sapiente possimus.","Eum qui quae."]OK response.
Create-WorkspaceResponseBody result type (default view)
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
POST /api/orgs/{org}/projects/{project}/workspaces HTTP/1.1
Host: localhost:80
Harness-Account: z26
Content-Type: application/json
Accept: */*
Content-Length: 3838
{
"associated_template": {
"template_id": "p",
"version": "kd2"
},
"budget": 0.837016,
"ccm_cost_enabled": false,
"cost_breakdown_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"cost_diff_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"cost_estimation_enabled": true,
"create_default_pipelines": true,
"default_pipelines": {
"Molestias aliquid deleniti nesciunt.": {
"project_pipeline": "Enim provident qui rerum.",
"workspace_pipeline": "Vel ut sint dolor non."
},
"Voluptas soluta.": {
"project_pipeline": "Enim provident qui rerum.",
"workspace_pipeline": "Vel ut sint dolor non."
},
"Voluptas sunt voluptatem ullam voluptas quod.": {
"project_pipeline": "Enim provident qui rerum.",
"workspace_pipeline": "Vel ut sint dolor non."
}
},
"description": "this is a more detailed explanation of the resource.",
"environment_variables": {
"Recusandae aliquid cumque ipsam.": {
"key": "ip",
"value": "Amet qui quaerat magni velit et.",
"value_type": "number"
}
},
"id": 1566479696924710100,
"identifier": "4",
"modules_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"name": "resource name",
"provider_connector": "Praesentium ducimus vitae rem culpa accusamus.",
"provider_connectors": [
{
"connector_ref": "o5y",
"created": 1627590400,
"id": 9061163623315803000,
"terragrunt_provider": false,
"type": "gcp",
"updated": 1627686800,
"workspace_id": 8939960908366302000
},
{
"connector_ref": "o5y",
"created": 1627590400,
"id": 9061163623315803000,
"terragrunt_provider": false,
"type": "gcp",
"updated": 1627686800,
"workspace_id": 8939960908366302000
},
{
"connector_ref": "o5y",
"created": 1627590400,
"id": 9061163623315803000,
"terragrunt_provider": false,
"type": "gcp",
"updated": 1627686800,
"workspace_id": 8939960908366302000
},
{
"connector_ref": "o5y",
"created": 1627590400,
"id": 9061163623315803000,
"terragrunt_provider": false,
"type": "gcp",
"updated": 1627686800,
"workspace_id": 8939960908366302000
}
],
"providers_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"provisioner": "Quisquam voluptas non aliquam quod totam dolor.",
"provisioner_configuration": "Pariatur laboriosam.",
"provisioner_version": "Cumque autem nihil porro quibusdam similique.",
"prune_sensitive_data": true,
"repository": "Qui aliquid molestias.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Laboriosam vero quasi nemo.",
"repository_path": "",
"repository_sha": "abc10ed",
"repository_submodules": "recursive",
"run_all": false,
"sparse_checkout": "Doloremque aut aut.",
"state_checksum": "d21c1662d8ce2c74f24efdc8db93eb34473b86810aeccca4b1518f70b0ccde8f",
"tags": {
"cost-center": "engineering",
"environment": "production",
"team": "platform"
},
"terraform_plan_json": "f9e21473daaa2674d862b67a1339f4570e86de17",
"terraform_state": "fc1200c7a7aa52109d762a9f005b149abef01479",
"terraform_state_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"terraform_variable_files": [
{
"repository": "Omnis facere numquam.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Quod repellat unde modi libero.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{
"repository": "Omnis facere numquam.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Quod repellat unde modi libero.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{
"repository": "Omnis facere numquam.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Quod repellat unde modi libero.",
"repository_path": "",
"repository_sha": "abc10ed"
}
],
"terraform_variables": {
"Corporis ipsa quis.": {
"key": "ip",
"value": "Amet qui quaerat magni velit et.",
"value_type": "number"
},
"Inventore illum quae cumque architecto sequi.": {
"key": "ip",
"value": "Amet qui quaerat magni velit et.",
"value_type": "number"
},
"Quod sequi impedit.": {
"key": "ip",
"value": "Amet qui quaerat magni velit et.",
"value_type": "number"
}
},
"terragrunt_provider": true,
"terragrunt_version": "Tenetur ut cupiditate eaque.",
"variable_sets": [
"Ut iure.",
"Ut enim minus voluptatem fuga."
]
}{
"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"
}
}Show an individual workspace.
Org is the organisation identifier.
3qrProject is the project identifier.
imeIdentifier is the project identifier.
miAccount is the internal customer account ID.
4mOK response.
Show-WorkspaceResponseBody result type (default view)
Account is the internal customer account ID.
sDefines if the remote backend is locked or not
falseExample: truedefine the budget for a specific workspace
0.24248117define if CCM cost integration is enabled for this workspace
falseExample: truecost_breakdown_json is the identifier to the breakdown cost file from the current execution that was applied successfully
c4a2d99bc28d236098a095277b7eb0718d6be068cost_diff_json is the identifier to the diff cost file between the previous and current successful executions
c4a2d99bc28d236098a095277b7eb0718d6be068define if cost estimation operations will be performed in this workspace
falseExample: trueCreated is the unix timestamp at which the resource was originally created in milliseconds.
5933685883716351000Description provides long-form text about the resource.
this is a more detailed explanation of the resource.Workspace identifier.
hzmodules_json is the identifier of any modules metadata associated with this workspace
c4a2d99bc28d236098a095277b7eb0718d6be068Name is the human readable name for the resource.
resource nameOrg is the organisation identifier.
55Project is the project identifier.
r9rProvider Connector is the reference to the connector for the infrastructure provider.
Cum quis culpa quos est.providers_json is the identifier of any modules metadata associated with this workspace
c4a2d99bc28d236098a095277b7eb0718d6be068Provisioner defines the provisioning tool to use.
Ipsa impedit qui quia.Provisioner configuration metadata (key value pair provisioner specific configuration).
Ex deleniti libero dignissimos amet laborum.Omnis perspiciatis est aspernatur id libero.Provisioner Version defines the tool version to use.
latestExample: Ullam officia.prune_sensitive_data is a flag to enable or disable pruning of sensitive data
falseExample: trueRepository is the name of the repository to use.
Vitae consectetur aut mollitia quod.Repository Branch in which the code should be accessed.
mainRepository Commit/Tag in which the code should be accessed.
abc10edRepository Connector is the reference to the connector to use for this code.
Accusantium delectus quos.Repository Path is the path in which the infra code resides.
""Repository SHA in which the code should be accessed.
abc10edrepository_submodules is the instruction about whether to clone submodules in the pipeline step
falseExample: recursivePossible values: Run-All terragrunt modules.
trueList of patterens that will be used for sparse checkout option of git clone
Voluptatum molestiae.state_checksum is the sha-256 checksum of terraform state file
d21c1662d8ce2c74f24efdc8db93eb34473b86810aeccca4b1518f70b0ccde8fThe status of the workspace
rollback_appliedPossible values: terraform_plan_json is the identifier to the current state file only in JSON format.
f9e21473daaa2674d862b67a1339f4570e86de17terraform_state is the identifier to the plan file used to create the latest state.
fc1200c7a7aa52109d762a9f005b149abef01479terraform_state_json is the identifier to the plan file used to create the latest state only in JSON format.
c4a2d99bc28d236098a095277b7eb0718d6be068Whether this workspace uses terragrunt to provision infrastructure
falseExample: falseTerragrunt Version to use when provisioner is terragrunt.
Quibusdam sint eos harum.Modified is the unix timestamp at which the resource was last modified in milliseconds.
8041006851860804000Attached Variable Sets references
["Sunt debitis autem.","Nostrum tempore beatae enim vel neque ullam.","Pariatur et porro dicta ad facilis.","Eum earum facilis."]BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/workspaces/{identifier} HTTP/1.1
Host: localhost:80
Harness-Account: 4m
Accept: */*
{
"account": "x43",
"associated_template": {
"template_id": "uv",
"version": "uh"
},
"backend_locked": false,
"budget": 0.8677249,
"ccm_cost_enabled": true,
"cost_breakdown_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"cost_diff_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"cost_estimation_enabled": true,
"created": 2672083173112297500,
"default_pipelines": {
"Perferendis tempore dolorem.": {
"project_pipeline": "Repellendus fugiat nemo reiciendis velit porro et.",
"workspace_pipeline": "Praesentium voluptas asperiores."
},
"Quia suscipit nostrum ea et at.": {
"project_pipeline": "Repellendus fugiat nemo reiciendis velit porro et.",
"workspace_pipeline": "Praesentium voluptas asperiores."
}
},
"description": "this is a more detailed explanation of the resource.",
"environment_variables": {
"Amet mollitia et voluptate omnis minima laboriosam.": {
"created": 2044074723353686500,
"key": "xjv",
"updated": 610470478830937900,
"value": "Quos sunt magni reiciendis sapiente aperiam ipsum.",
"value_type": "json"
}
},
"identifier": "2sd",
"lock": {
"created_at": 4486103249482315300,
"id": "Autem et.",
"locked_by_display_name": "Dolores dicta maxime dicta.",
"locked_by_principal_id": "Voluptatum veritatis dolore.",
"locked_by_principal_type": "Velit expedita.",
"manual": true,
"reason": "Non adipisci."
},
"modules_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"name": "resource name",
"org": "u1",
"project": "1ni",
"provider_connector": "Recusandae quaerat est aperiam dolorum nostrum.",
"provider_connectors": [
{
"connector_ref": "w78",
"created": 1627590400,
"id": 1403491781209685000,
"terragrunt_provider": false,
"type": "vault",
"updated": 1627686800,
"workspace_id": 8865635828231279000
},
{
"connector_ref": "w78",
"created": 1627590400,
"id": 1403491781209685000,
"terragrunt_provider": false,
"type": "vault",
"updated": 1627686800,
"workspace_id": 8865635828231279000
},
{
"connector_ref": "w78",
"created": 1627590400,
"id": 1403491781209685000,
"terragrunt_provider": false,
"type": "vault",
"updated": 1627686800,
"workspace_id": 8865635828231279000
},
{
"connector_ref": "w78",
"created": 1627590400,
"id": 1403491781209685000,
"terragrunt_provider": false,
"type": "vault",
"updated": 1627686800,
"workspace_id": 8865635828231279000
}
],
"providers_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"provisioner": "Facere non veritatis quibusdam quidem.",
"provisioner_configuration": "Ab tempora et nemo quidem ad molestias.",
"provisioner_data": "Sint sint dolorum quo quod.",
"provisioner_version": "Culpa eaque quis dolores.",
"prune_sensitive_data": true,
"repository": "Assumenda et beatae sit et iure.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Aliquid in.",
"repository_path": "",
"repository_sha": "abc10ed",
"repository_submodules": "recursive",
"run_all": false,
"sparse_checkout": "Natus ea fugit porro assumenda et nulla.",
"state_checksum": "d21c1662d8ce2c74f24efdc8db93eb34473b86810aeccca4b1518f70b0ccde8f",
"status": "active",
"tags": {
"cost-center": "engineering",
"environment": "production",
"team": "platform"
},
"terraform_plan_json": "f9e21473daaa2674d862b67a1339f4570e86de17",
"terraform_state": "fc1200c7a7aa52109d762a9f005b149abef01479",
"terraform_state_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"terraform_variable_files": [
{
"repository": "Sapiente rerum vero fugit in velit.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Dolores id non odio molestiae nisi.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{
"repository": "Sapiente rerum vero fugit in velit.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Dolores id non odio molestiae nisi.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{
"repository": "Sapiente rerum vero fugit in velit.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Dolores id non odio molestiae nisi.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{
"repository": "Sapiente rerum vero fugit in velit.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Dolores id non odio molestiae nisi.",
"repository_path": "",
"repository_sha": "abc10ed"
}
],
"terraform_variables": {
"Asperiores libero atque.": {
"created": 2044074723353686500,
"key": "xjv",
"updated": 610470478830937900,
"value": "Quos sunt magni reiciendis sapiente aperiam ipsum.",
"value_type": "json"
},
"Eum et sapiente et quod.": {
"created": 2044074723353686500,
"key": "xjv",
"updated": 610470478830937900,
"value": "Quos sunt magni reiciendis sapiente aperiam ipsum.",
"value_type": "json"
},
"Quis qui.": {
"created": 2044074723353686500,
"key": "xjv",
"updated": 610470478830937900,
"value": "Quos sunt magni reiciendis sapiente aperiam ipsum.",
"value_type": "json"
}
},
"terragrunt_provider": false,
"terragrunt_version": "Voluptatibus est quo.",
"updated": 4279440511824908000,
"variable_sets": [
"Occaecati mollitia tenetur quis libero debitis.",
"Facere ipsa consequuntur voluptatem ratione voluptas fugiat.",
"Aut laborum est."
]
}Updates the given workspace with new info.
Org is the organisation identifier.
csProject is the project identifier.
npWorkspace identifier.
wkoAccount is the internal customer account ID.
dadefine the budget for a specific workspace
0.8361195define if CCM cost integration is enabled for this workspace
falseExample: falsedefine if cost estimation operations will be performed in this workspace
falseExample: trueDescription provides long-form text about the resource.
this is a more detailed explanation of the resource.Name is the human readable name for the resource.
resource nameProvider Connector is the reference to the connector for the infrastructure provider.
Quis labore cum suscipit.Provisioner defines the provisioning tool to use.
Aut harum rem adipisci sapiente ut voluptatem.Provisioner configuration metadata (key value pair provisioner specific configuration).
Et saepe accusantium occaecati et.Provisioner Version defines the tool version to use.
latestExample: Suscipit dolor ea maiores aliquam perferendis.prune_sensitive_data is a flag to enable or disable pruning of sensitive data
falseExample: trueRepository is the name of the repository to use.
Nihil et repellat.Repository Branch in which the code should be accessed.
mainRepository Commit/Tag in which the code should be accessed.
abc10edRepository Connector is the reference to the connector to use for this code.
Nostrum sit unde optio eveniet.Repository Path is the path in which the infra code resides.
""Repository SHA in which the code should be accessed.
abc10edrepository_submodules is the instruction about whether to clone submodules in the pipeline step
falseExample: recursivePossible values: Run-All terragrunt modules.
trueList of patterens that will be used for sparse checkout option of git clone
Eveniet dolores nesciunt ut numquam.Whether this workspace uses terragrunt to provision infrastructure
falseExample: falseTerragrunt Version to use when provisioner is terragrunt.
Quos eos vel vero et quis ea.Attached Variable Sets references
["Fugiat sit quidem at consequatur cumque.","Officiis omnis autem qui dolores."]OK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
PUT /api/orgs/{org}/projects/{project}/workspaces/{identifier} HTTP/1.1
Host: localhost:80
Harness-Account: da
Content-Type: application/json
Accept: */*
Content-Length: 3048
{
"budget": 0.7964625,
"ccm_cost_enabled": true,
"cost_estimation_enabled": true,
"default_pipelines": {
"Dolorem dignissimos tempore et odio corrupti et.": {
"project_pipeline": "Enim provident qui rerum.",
"workspace_pipeline": "Vel ut sint dolor non."
},
"Sit blanditiis sunt ut.": {
"project_pipeline": "Enim provident qui rerum.",
"workspace_pipeline": "Vel ut sint dolor non."
}
},
"description": "this is a more detailed explanation of the resource.",
"environment_variables": {
"Adipisci non et sunt.": {
"key": "ip",
"value": "Amet qui quaerat magni velit et.",
"value_type": "number"
},
"Nostrum rerum ut voluptatem voluptas.": {
"key": "ip",
"value": "Amet qui quaerat magni velit et.",
"value_type": "number"
},
"Voluptas adipisci.": {
"key": "ip",
"value": "Amet qui quaerat magni velit et.",
"value_type": "number"
}
},
"name": "resource name",
"provider_connector": "Recusandae facilis quis molestiae voluptates.",
"provider_connectors": [
{
"connector_ref": "o5y",
"created": 1627590400,
"id": 9061163623315803000,
"terragrunt_provider": false,
"type": "gcp",
"updated": 1627686800,
"workspace_id": 8939960908366302000
},
{
"connector_ref": "o5y",
"created": 1627590400,
"id": 9061163623315803000,
"terragrunt_provider": false,
"type": "gcp",
"updated": 1627686800,
"workspace_id": 8939960908366302000
},
{
"connector_ref": "o5y",
"created": 1627590400,
"id": 9061163623315803000,
"terragrunt_provider": false,
"type": "gcp",
"updated": 1627686800,
"workspace_id": 8939960908366302000
},
{
"connector_ref": "o5y",
"created": 1627590400,
"id": 9061163623315803000,
"terragrunt_provider": false,
"type": "gcp",
"updated": 1627686800,
"workspace_id": 8939960908366302000
}
],
"provisioner": "Voluptatem saepe.",
"provisioner_configuration": "Sunt repudiandae totam.",
"provisioner_version": "Ipsam qui.",
"prune_sensitive_data": true,
"repository": "Dolorum id esse rem aut.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Voluptas totam explicabo.",
"repository_path": "",
"repository_sha": "abc10ed",
"repository_submodules": "recursive",
"run_all": true,
"sparse_checkout": "Rerum architecto qui fugit laborum.",
"tags": {
"cost-center": "engineering",
"environment": "production",
"team": "platform"
},
"terraform_variable_files": [
{
"repository": "Omnis facere numquam.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Quod repellat unde modi libero.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{
"repository": "Omnis facere numquam.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Quod repellat unde modi libero.",
"repository_path": "",
"repository_sha": "abc10ed"
}
],
"terraform_variables": {
"Ipsam est iusto.": {
"key": "ip",
"value": "Amet qui quaerat magni velit et.",
"value_type": "number"
},
"Vel facilis deleniti eum odio nihil.": {
"key": "ip",
"value": "Amet qui quaerat magni velit et.",
"value_type": "number"
}
},
"terragrunt_provider": false,
"terragrunt_version": "Nostrum at pariatur ut quis veniam et.",
"variable_sets": [
"Sint in magnam excepturi quam quis.",
"Recusandae ex laboriosam rerum.",
"Enim eos quaerat quis sit quos adipisci.",
"Deserunt dolorem accusamus ipsam maiores eum molestias."
]
}{
"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"
}
}Deletes the given workspace.
Org is the organisation identifier.
dfxProject is the project identifier.
kIdentifier is the project identifier.
bAccount is the internal customer account ID.
ainNo Content response.
No content
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
DELETE /api/orgs/{org}/projects/{project}/workspaces/{identifier} HTTP/1.1
Host: localhost:80
Harness-Account: ain
Accept: */*
No content
Unlock a workspace, removing the lock regardless of its origin (manual or automatic). Idempotent.
Org is the organisation identifier.
bProject is the project identifier.
uIdentifier is the project identifier.
mqnAccount is the internal customer account ID.
0OK response.
No content
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
POST /api/orgs/{org}/projects/{project}/workspaces/{identifier}/actions/force-unlock HTTP/1.1
Host: localhost:80
Harness-Account: 0
Accept: */*
No content
Create a manual lock on a workspace.
Org is the organisation identifier.
dProject is the project identifier.
cIdentifier is the project identifier.
vh6Account is the internal customer account ID.
4scReason for locking the workspace (optional)
Q2 freezeOK response.
Lock ID
ae73eacd-4118-4444-866d-972b0dbbaf7bDisplay name of who locked
Corporis nisi numquam ea excepturi sint.Principal ID who locked
Incidunt suscipit assumenda autem.Type of principal
Enim ut aliquam.Whether the lock is manual (user-initiated). true = manual lock, false = automatic lock
trueReason for lock
Rerum omnis corporis.Workspace identifier
Cumque at totam velit voluptas.BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
POST /api/orgs/{org}/projects/{project}/workspaces/{identifier}/actions/lock HTTP/1.1
Host: localhost:80
Harness-Account: 4sc
Content-Type: application/json
Accept: */*
Content-Length: 22
{
"reason": "Q2 freeze"
}{
"id": "c01a87e3-c2d7-460c-958b-c3f8a0b75a87",
"locked_by_display_name": "Deserunt doloribus enim temporibus illum.",
"locked_by_principal_id": "Vero repellendus recusandae.",
"locked_by_principal_type": "Ex adipisci eos et.",
"manual": false,
"reason": "Reiciendis unde quam iusto id voluptate nesciunt.",
"workspace": "Excepturi quas perspiciatis."
}List modules associated with this workspace.
Org is the organisation identifier.
yr4Project is the project identifier.
onIdentifier is the project identifier.
604Account is the internal customer account ID.
phOK response.
Represents an individual OpenTofu or Terraform module.
Number of times this module is invoked in the workspace
3Module key
ec2-instance_testModule source
registry.opentofu.org/terraform-aws-modules/ec2-instance/aws//examples/completeTerragrunt stack path (empty for regular Terraform workspaces)
environments/prod/ec2Module version
5.0.0BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/workspaces/{identifier}/modules HTTP/1.1
Host: localhost:80
Harness-Account: ph
Accept: */*
[
{
"invocations": 3,
"key": "ec2-instance_test",
"source": "registry.opentofu.org/terraform-aws-modules/ec2-instance/aws//examples/complete",
"stack_path": "environments/prod/ec2",
"version": "5.0.0"
},
{
"invocations": 3,
"key": "ec2-instance_test",
"source": "registry.opentofu.org/terraform-aws-modules/ec2-instance/aws//examples/complete",
"stack_path": "environments/prod/ec2",
"version": "5.0.0"
}
]List resources associated with this workspace.
Org is the organisation identifier.
bProject is the project identifier.
3q2Workspace identifier.
dLimit is the number of records to return for a page. When omitted, all records are returned.
30Page is the page number to return relative to the page 'limit'. When omitted, all records are returned.
1Resource types to filter by.
["aws_instance","google_compute_instance"]Account is the internal customer account ID.
8cOK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/workspaces/{identifier}/resources HTTP/1.1
Host: localhost:80
Harness-Account: 8c
Accept: */*
{
"data_sources": [
{
"attributes": {
"ami": "ami-830c94ec",
"instance_type": "t2.micro"
},
"createdAt": 1627590400,
"drift_attributes": {
"instance_type": "t2.nano"
},
"drift_status": "changed",
"lastSyncedAt": 1627686800,
"mode": "resource",
"module": "full_stack",
"monthly_cost": 0.6746256985802211,
"monthly_saving": 0.09219667128621589,
"name": "app_server",
"path_id": "namespace",
"provider": "AWS",
"recommendation_count": 8649719887937091000,
"resource_id": "arn:aws:s3:::my-bucket",
"sensitive_attributes": [
"instance_type"
],
"type": "S3 Bucket"
},
{
"attributes": {
"ami": "ami-830c94ec",
"instance_type": "t2.micro"
},
"createdAt": 1627590400,
"drift_attributes": {
"instance_type": "t2.nano"
},
"drift_status": "changed",
"lastSyncedAt": 1627686800,
"mode": "resource",
"module": "full_stack",
"monthly_cost": 0.6746256985802211,
"monthly_saving": 0.09219667128621589,
"name": "app_server",
"path_id": "namespace",
"provider": "AWS",
"recommendation_count": 8649719887937091000,
"resource_id": "arn:aws:s3:::my-bucket",
"sensitive_attributes": [
"instance_type"
],
"type": "S3 Bucket"
},
{
"attributes": {
"ami": "ami-830c94ec",
"instance_type": "t2.micro"
},
"createdAt": 1627590400,
"drift_attributes": {
"instance_type": "t2.nano"
},
"drift_status": "changed",
"lastSyncedAt": 1627686800,
"mode": "resource",
"module": "full_stack",
"monthly_cost": 0.6746256985802211,
"monthly_saving": 0.09219667128621589,
"name": "app_server",
"path_id": "namespace",
"provider": "AWS",
"recommendation_count": 8649719887937091000,
"resource_id": "arn:aws:s3:::my-bucket",
"sensitive_attributes": [
"instance_type"
],
"type": "S3 Bucket"
},
{
"attributes": {
"ami": "ami-830c94ec",
"instance_type": "t2.micro"
},
"createdAt": 1627590400,
"drift_attributes": {
"instance_type": "t2.nano"
},
"drift_status": "changed",
"lastSyncedAt": 1627686800,
"mode": "resource",
"module": "full_stack",
"monthly_cost": 0.6746256985802211,
"monthly_saving": 0.09219667128621589,
"name": "app_server",
"path_id": "namespace",
"provider": "AWS",
"recommendation_count": 8649719887937091000,
"resource_id": "arn:aws:s3:::my-bucket",
"sensitive_attributes": [
"instance_type"
],
"type": "S3 Bucket"
}
],
"outputs": [
{
"expression": "<+outputs.instance_id>",
"name": "instance_public_ip",
"sensitive": true,
"stack_path": "IaCM/TGOverride/environments/dev/ec2",
"value": "Deserunt error nobis in corrupti quia odio."
},
{
"expression": "<+outputs.instance_id>",
"name": "instance_public_ip",
"sensitive": true,
"stack_path": "IaCM/TGOverride/environments/dev/ec2",
"value": "Deserunt error nobis in corrupti quia odio."
}
],
"resources": [
{
"attributes": {
"ami": "ami-830c94ec",
"instance_type": "t2.micro"
},
"createdAt": 1627590400,
"drift_attributes": {
"instance_type": "t2.nano"
},
"drift_status": "changed",
"lastSyncedAt": 1627686800,
"mode": "resource",
"module": "full_stack",
"monthly_cost": 0.6746256985802211,
"monthly_saving": 0.09219667128621589,
"name": "app_server",
"path_id": "namespace",
"provider": "AWS",
"recommendation_count": 8649719887937091000,
"resource_id": "arn:aws:s3:::my-bucket",
"sensitive_attributes": [
"instance_type"
],
"type": "S3 Bucket"
},
{
"attributes": {
"ami": "ami-830c94ec",
"instance_type": "t2.micro"
},
"createdAt": 1627590400,
"drift_attributes": {
"instance_type": "t2.nano"
},
"drift_status": "changed",
"lastSyncedAt": 1627686800,
"mode": "resource",
"module": "full_stack",
"monthly_cost": 0.6746256985802211,
"monthly_saving": 0.09219667128621589,
"name": "app_server",
"path_id": "namespace",
"provider": "AWS",
"recommendation_count": 8649719887937091000,
"resource_id": "arn:aws:s3:::my-bucket",
"sensitive_attributes": [
"instance_type"
],
"type": "S3 Bucket"
},
{
"attributes": {
"ami": "ami-830c94ec",
"instance_type": "t2.micro"
},
"createdAt": 1627590400,
"drift_attributes": {
"instance_type": "t2.nano"
},
"drift_status": "changed",
"lastSyncedAt": 1627686800,
"mode": "resource",
"module": "full_stack",
"monthly_cost": 0.6746256985802211,
"monthly_saving": 0.09219667128621589,
"name": "app_server",
"path_id": "namespace",
"provider": "AWS",
"recommendation_count": 8649719887937091000,
"resource_id": "arn:aws:s3:::my-bucket",
"sensitive_attributes": [
"instance_type"
],
"type": "S3 Bucket"
},
{
"attributes": {
"ami": "ami-830c94ec",
"instance_type": "t2.micro"
},
"createdAt": 1627590400,
"drift_attributes": {
"instance_type": "t2.nano"
},
"drift_status": "changed",
"lastSyncedAt": 1627686800,
"mode": "resource",
"module": "full_stack",
"monthly_cost": 0.6746256985802211,
"monthly_saving": 0.09219667128621589,
"name": "app_server",
"path_id": "namespace",
"provider": "AWS",
"recommendation_count": 8649719887937091000,
"resource_id": "arn:aws:s3:::my-bucket",
"sensitive_attributes": [
"instance_type"
],
"type": "S3 Bucket"
}
],
"stack_outputs": {
"IaCM/TGOverride/environments/dev/ec2": [
{
"name": "instance_id",
"sensitive": false,
"stack_path": "IaCM/TGOverride/environments/dev/ec2",
"value": "i-1234567890abcdef0"
}
]
},
"total_resources": 42
}Get a single provisioned resource by its IaCM resource ID (resources.id UUID). Returns the same Resource shape as list-resources.
Org is the organisation identifier.
eProject is the project identifier.
rnwWorkspace identifier.
8lrIaCM resource ID (resources.id UUID).
11111111-1111-1111-1111-111111111111Account is the internal customer account ID.
l2zOK response.
Timestamp when the resource was created.
1627590400Indicates if this resource is experiencing drift.
changedPossible values: Timestamp when the resource was last updated.
1627686800Mode associated with the resource.
resourcePossible values: Module associated with the resource.
full_stackCurrent period cost from CCM (null if no cost data).
0.11418498928154362Monthly potential saving from CCM (null if no cost data).
0.9333841350301846Name associated with the resource.
app_serverPath associated with the resource. Could be namespace, environment or stack id.
namespaceCloud provider associated with the resource.
AWSNumber of CCM recommendations for this resource (null if no cost data).
3080594148715876400Unique identifier for the resource from the cloud provider.
arn:aws:s3:::my-bucketType of the provisioned resource.
S3 BucketBadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/workspaces/{identifier}/resources/{id} HTTP/1.1
Host: localhost:80
Harness-Account: l2z
Accept: */*
{
"attributes": {
"ami": "ami-830c94ec",
"instance_type": "t2.micro"
},
"createdAt": 1627590400,
"drift_attributes": {
"instance_type": "t2.nano"
},
"drift_status": "changed",
"lastSyncedAt": 1627686800,
"mode": "resource",
"module": "full_stack",
"monthly_cost": 0.5430484459281941,
"monthly_saving": 0.25187163585491273,
"name": "app_server",
"path_id": "namespace",
"provider": "AWS",
"recommendation_count": 3536487341731637000,
"resource_id": "arn:aws:s3:::my-bucket",
"sensitive_attributes": [
"instance_type"
],
"type": "S3 Bucket"
}List resources for a workspace using selectors. Pagination is optional: when limit and page are omitted (or zero), all matching resources are returned for backward compatibility.
Org is the organisation identifier.
fekProject is the project identifier.
dvvWorkspace identifier
A voluptatem ad provident minima quibusdam id.Account is the internal customer account ID.
aLimit is the number of records to return for a page. When omitted, all records are returned.
30Page is the page number to return relative to the page 'limit'. When omitted, all records are returned.
1OK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
POST /api/orgs/{org}/projects/{project}/workspaces/{identifier}/resources/search HTTP/1.1
Host: localhost:80
Harness-Account: a
Content-Type: application/json
Accept: */*
Content-Length: 578
{
"limit": 30,
"page": 1,
"selectors": [
{
"include_conditions": [
{
"attribute": "tag.environment",
"operator": "equals",
"value": "prod"
}
],
"path_id": "qa",
"provider": "aws",
"resource_type": "aws_instance",
"search_text": "some text"
},
{
"include_conditions": [
{
"attribute": "tag.environment",
"operator": "equals",
"value": "prod"
}
],
"path_id": "qa",
"provider": "aws",
"resource_type": "aws_instance",
"search_text": "some text"
},
{
"include_conditions": [
{
"attribute": "tag.environment",
"operator": "equals",
"value": "prod"
}
],
"path_id": "qa",
"provider": "aws",
"resource_type": "aws_instance",
"search_text": "some text"
}
]
}{
"data_sources": [
{
"attributes": {
"ami": "ami-830c94ec",
"instance_type": "t2.micro"
},
"createdAt": 1627590400,
"drift_attributes": {
"instance_type": "t2.nano"
},
"drift_status": "changed",
"lastSyncedAt": 1627686800,
"mode": "resource",
"module": "full_stack",
"monthly_cost": 0.6746256985802211,
"monthly_saving": 0.09219667128621589,
"name": "app_server",
"path_id": "namespace",
"provider": "AWS",
"recommendation_count": 8649719887937091000,
"resource_id": "arn:aws:s3:::my-bucket",
"sensitive_attributes": [
"instance_type"
],
"type": "S3 Bucket"
},
{
"attributes": {
"ami": "ami-830c94ec",
"instance_type": "t2.micro"
},
"createdAt": 1627590400,
"drift_attributes": {
"instance_type": "t2.nano"
},
"drift_status": "changed",
"lastSyncedAt": 1627686800,
"mode": "resource",
"module": "full_stack",
"monthly_cost": 0.6746256985802211,
"monthly_saving": 0.09219667128621589,
"name": "app_server",
"path_id": "namespace",
"provider": "AWS",
"recommendation_count": 8649719887937091000,
"resource_id": "arn:aws:s3:::my-bucket",
"sensitive_attributes": [
"instance_type"
],
"type": "S3 Bucket"
},
{
"attributes": {
"ami": "ami-830c94ec",
"instance_type": "t2.micro"
},
"createdAt": 1627590400,
"drift_attributes": {
"instance_type": "t2.nano"
},
"drift_status": "changed",
"lastSyncedAt": 1627686800,
"mode": "resource",
"module": "full_stack",
"monthly_cost": 0.6746256985802211,
"monthly_saving": 0.09219667128621589,
"name": "app_server",
"path_id": "namespace",
"provider": "AWS",
"recommendation_count": 8649719887937091000,
"resource_id": "arn:aws:s3:::my-bucket",
"sensitive_attributes": [
"instance_type"
],
"type": "S3 Bucket"
},
{
"attributes": {
"ami": "ami-830c94ec",
"instance_type": "t2.micro"
},
"createdAt": 1627590400,
"drift_attributes": {
"instance_type": "t2.nano"
},
"drift_status": "changed",
"lastSyncedAt": 1627686800,
"mode": "resource",
"module": "full_stack",
"monthly_cost": 0.6746256985802211,
"monthly_saving": 0.09219667128621589,
"name": "app_server",
"path_id": "namespace",
"provider": "AWS",
"recommendation_count": 8649719887937091000,
"resource_id": "arn:aws:s3:::my-bucket",
"sensitive_attributes": [
"instance_type"
],
"type": "S3 Bucket"
}
],
"outputs": [
{
"expression": "<+outputs.instance_id>",
"name": "instance_public_ip",
"sensitive": true,
"stack_path": "IaCM/TGOverride/environments/dev/ec2",
"value": "Deserunt error nobis in corrupti quia odio."
},
{
"expression": "<+outputs.instance_id>",
"name": "instance_public_ip",
"sensitive": true,
"stack_path": "IaCM/TGOverride/environments/dev/ec2",
"value": "Deserunt error nobis in corrupti quia odio."
}
],
"resources": [
{
"attributes": {
"ami": "ami-830c94ec",
"instance_type": "t2.micro"
},
"createdAt": 1627590400,
"drift_attributes": {
"instance_type": "t2.nano"
},
"drift_status": "changed",
"lastSyncedAt": 1627686800,
"mode": "resource",
"module": "full_stack",
"monthly_cost": 0.6746256985802211,
"monthly_saving": 0.09219667128621589,
"name": "app_server",
"path_id": "namespace",
"provider": "AWS",
"recommendation_count": 8649719887937091000,
"resource_id": "arn:aws:s3:::my-bucket",
"sensitive_attributes": [
"instance_type"
],
"type": "S3 Bucket"
},
{
"attributes": {
"ami": "ami-830c94ec",
"instance_type": "t2.micro"
},
"createdAt": 1627590400,
"drift_attributes": {
"instance_type": "t2.nano"
},
"drift_status": "changed",
"lastSyncedAt": 1627686800,
"mode": "resource",
"module": "full_stack",
"monthly_cost": 0.6746256985802211,
"monthly_saving": 0.09219667128621589,
"name": "app_server",
"path_id": "namespace",
"provider": "AWS",
"recommendation_count": 8649719887937091000,
"resource_id": "arn:aws:s3:::my-bucket",
"sensitive_attributes": [
"instance_type"
],
"type": "S3 Bucket"
},
{
"attributes": {
"ami": "ami-830c94ec",
"instance_type": "t2.micro"
},
"createdAt": 1627590400,
"drift_attributes": {
"instance_type": "t2.nano"
},
"drift_status": "changed",
"lastSyncedAt": 1627686800,
"mode": "resource",
"module": "full_stack",
"monthly_cost": 0.6746256985802211,
"monthly_saving": 0.09219667128621589,
"name": "app_server",
"path_id": "namespace",
"provider": "AWS",
"recommendation_count": 8649719887937091000,
"resource_id": "arn:aws:s3:::my-bucket",
"sensitive_attributes": [
"instance_type"
],
"type": "S3 Bucket"
},
{
"attributes": {
"ami": "ami-830c94ec",
"instance_type": "t2.micro"
},
"createdAt": 1627590400,
"drift_attributes": {
"instance_type": "t2.nano"
},
"drift_status": "changed",
"lastSyncedAt": 1627686800,
"mode": "resource",
"module": "full_stack",
"monthly_cost": 0.6746256985802211,
"monthly_saving": 0.09219667128621589,
"name": "app_server",
"path_id": "namespace",
"provider": "AWS",
"recommendation_count": 8649719887937091000,
"resource_id": "arn:aws:s3:::my-bucket",
"sensitive_attributes": [
"instance_type"
],
"type": "S3 Bucket"
}
],
"stack_outputs": {
"IaCM/TGOverride/environments/dev/ec2": [
{
"name": "instance_id",
"sensitive": false,
"stack_path": "IaCM/TGOverride/environments/dev/ec2",
"value": "i-1234567890abcdef0"
}
]
},
"total_resources": 42
}Clone the given workspace with new name.
Org is the organisation identifier.
k0lProject is the project identifier.
foUt at.Account is the internal customer account ID.
pWorkspace identifier.
lyPattern: ^[A-Za-z_][A-Za-z0-9_-]*$Name is the human readable name for the resource.
resource namePattern: ^[A-Za-z_][A-Za-z0-9_ -]*$OK response.
Create-WorkspaceResponseBody result type (default view)
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
POST /api/orgs/{org}/projects/{project}/workspaces/{workspace}/clone HTTP/1.1
Host: localhost:80
Harness-Account: p
Content-Type: application/json
Accept: */*
Content-Length: 41
{
"identifier": "2",
"name": "resource name"
}{
"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 all stored data for a workspace.
Org is the organisation identifier.
lProject is the project identifier.
d0aWorkspace identifier
Odit non voluptatem in.Filter by pipeline execution ID
Aperiam laborum dolorem veritatis.Filter by pipeline execution stage ID
Vero quam voluptas distinctio quod aperiam consequatur.Filter by provisioner type
Porro doloremque voluptatem dolorem sed est voluptatem.Filter by data type
Ipsa omnis molestias earum optio fuga consequatur.Filter by stack path
Quia omnis.Limit is the number of records to return for a page.
30Example: 30Page is the page number to return relative to the page 'limit'.
1Example: 1Account is the internal customer account ID.
pOK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/workspaces/{workspace}/data HTTP/1.1
Host: localhost:80
Harness-Account: p
Accept: */*
[
{
"account": "jqc",
"created": 2342968059504325000,
"data_type": "cdk_diff",
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"org": "4",
"pipeline_execution_id": "Sint optio.",
"pipeline_id": "Aut voluptas omnis praesentium atque itaque praesentium.",
"pipeline_stage_id": "Illo laborum eum cumque nostrum aut voluptas.",
"project": "k",
"provisioner_type": "awscdk",
"rollback_source_id": "Sunt eos quia sapiente.",
"stack_path": "Est et officiis sint voluptates dolorum.",
"stage_id": "Esse tenetur dolore et earum quis.",
"workspace": "workspace123"
},
{
"account": "jqc",
"created": 2342968059504325000,
"data_type": "cdk_diff",
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"org": "4",
"pipeline_execution_id": "Sint optio.",
"pipeline_id": "Aut voluptas omnis praesentium atque itaque praesentium.",
"pipeline_stage_id": "Illo laborum eum cumque nostrum aut voluptas.",
"project": "k",
"provisioner_type": "awscdk",
"rollback_source_id": "Sunt eos quia sapiente.",
"stack_path": "Est et officiis sint voluptates dolorum.",
"stage_id": "Esse tenetur dolore et earum quis.",
"workspace": "workspace123"
},
{
"account": "jqc",
"created": 2342968059504325000,
"data_type": "cdk_diff",
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"org": "4",
"pipeline_execution_id": "Sint optio.",
"pipeline_id": "Aut voluptas omnis praesentium atque itaque praesentium.",
"pipeline_stage_id": "Illo laborum eum cumque nostrum aut voluptas.",
"project": "k",
"provisioner_type": "awscdk",
"rollback_source_id": "Sunt eos quia sapiente.",
"stack_path": "Est et officiis sint voluptates dolorum.",
"stage_id": "Esse tenetur dolore et earum quis.",
"workspace": "workspace123"
}
]Store binary data generated by the provisioner, such as plans and state files.
Org is the organisation identifier.
s0pProject is the project identifier.
yWorkspace identifier
workspace123The unique identifier for the associated pipeline
Blanditiis rerum nostrum perferendis sit eligendi.The unique identifier for a stage
Ipsam rem neque.The unique identifier for the associated pipeline execution
Voluptate sit quaerat eum non aut.The unique identifier for the associated pipeline execution stage
Libero impedit hic eaque aut.Type of provisioner that created the data
tfPossible values: Type of data stored
providersPossible values: Policy action used during OPA evaluation
afterTerraformApplyIndicates the plugin supports OPA SDK-based evaluation
trueOptional path to the stack module
Adipisci dignissimos totam rerum.Account is the internal customer account ID.
p6dSize in bytes of the data.
5950394984476017000OK response.
The unique identifier for the data
dc538c61-de48-4220-958c-5f3c4f983daaPre-rendered message included when policy evaluation did not pass
- instance type 'xlarge' is not permittedThe overall status of policy evaluation (if it occurred) indicating whether it passed
errorPossible values: BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
POST /api/orgs/{org}/projects/{project}/workspaces/{workspace}/data?pipeline_id=Blanditiis+rerum+nostrum+perferendis+sit+eligendi.&stage_id=Ipsam+rem+neque.&pipeline_execution_id=Voluptate+sit+quaerat+eum+non+aut.&pipeline_stage_id=Libero+impedit+hic+eaque+aut.&provisioner_type=tf&data_type=providers HTTP/1.1
Host: localhost:80
Harness-Account: p6d
Accept: */*
{
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"policy_evaluation": [
{
"message": "Labore quas debitis numquam voluptatem et.",
"policy_id": "Quisquam eos tempore amet aliquid molestias quisquam.",
"policy_name": "Eum accusantium soluta ab non fugiat.",
"policy_set_id": "Aut nihil quas est aspernatur illo qui.",
"policy_set_name": "Autem dolorum itaque.",
"policy_status": "Esse porro alias dolorem."
},
{
"message": "Labore quas debitis numquam voluptatem et.",
"policy_id": "Quisquam eos tempore amet aliquid molestias quisquam.",
"policy_name": "Eum accusantium soluta ab non fugiat.",
"policy_set_id": "Aut nihil quas est aspernatur illo qui.",
"policy_set_name": "Autem dolorum itaque.",
"policy_status": "Esse porro alias dolorem."
}
],
"policy_evaluation_message": "- instance type 'xlarge' is not permitted",
"policy_evaluation_status": "error"
}Get binary data generated by the provisioner, such as plans and state files.
Org is the organisation identifier.
qgProject is the project identifier.
mWorkspace is the resource workspace this variable is associated with.
Delectus recusandae praesentium eos et perferendis ut.The unique identifier for the data
dc538c61-de48-4220-958c-5f3c4f983daaAccount is the internal customer account ID.
9zOK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/workspaces/{workspace}/data/{id} HTTP/1.1
Host: localhost:80
Harness-Account: 9z
Accept: */*
binaryEvaluate policy against previously stored data, such as plans and state files.
Org is the organisation identifier.
y8dProject is the project identifier.
wWorkspace is the resource workspace this variable is associated with.
Recusandae minima qui.The unique identifier for the data
dc538c61-de48-4220-958c-5f3c4f983daaPipeline execution associated with this evaluation
Qui vitae at nihil velit ad.Policy action used during OPA evaluation
afterTerraformApplyAccount is the internal customer account ID.
c20OK response.
The unique identifier for the data
dc538c61-de48-4220-958c-5f3c4f983daaPre-rendered message included when policy evaluation did not pass
- instance type 'xlarge' is not permittedThe overall status of policy evaluation (if it occurred) indicating whether it passed
errorPossible values: BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/workspaces/{workspace}/data/{id}/evaluate-policy?policy_action=afterTerraformApply HTTP/1.1
Host: localhost:80
Harness-Account: c20
Accept: */*
{
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"policy_evaluation": [
{
"message": "Labore quas debitis numquam voluptatem et.",
"policy_id": "Quisquam eos tempore amet aliquid molestias quisquam.",
"policy_name": "Eum accusantium soluta ab non fugiat.",
"policy_set_id": "Aut nihil quas est aspernatur illo qui.",
"policy_set_name": "Autem dolorum itaque.",
"policy_status": "Esse porro alias dolorem."
},
{
"message": "Labore quas debitis numquam voluptatem et.",
"policy_id": "Quisquam eos tempore amet aliquid molestias quisquam.",
"policy_name": "Eum accusantium soluta ab non fugiat.",
"policy_set_id": "Aut nihil quas est aspernatur illo qui.",
"policy_set_name": "Autem dolorum itaque.",
"policy_status": "Esse porro alias dolorem."
},
{
"message": "Labore quas debitis numquam voluptatem et.",
"policy_id": "Quisquam eos tempore amet aliquid molestias quisquam.",
"policy_name": "Eum accusantium soluta ab non fugiat.",
"policy_set_id": "Aut nihil quas est aspernatur illo qui.",
"policy_set_name": "Autem dolorum itaque.",
"policy_status": "Esse porro alias dolorem."
}
],
"policy_evaluation_message": "- instance type 'xlarge' is not permitted",
"policy_evaluation_status": "error"
}Upload dependency graph for an existing plan file.
Org is the organisation identifier.
3diProject is the project identifier.
9Workspace identifier
workspace123The unique identifier for the associated pipeline
Quasi omnis.The unique identifier for a stage
Voluptas nostrum harum.The unique identifier for the associated pipeline execution
Est omnis excepturi magnam nihil.The unique identifier for the associated pipeline execution stage
Vitae sit maxime esse quaerat.Type of provisioner that created the data
awscdkPossible values: Type of data stored
cost_breakdownPossible values: Optional path to the stack module
Alias voluptas quos.Account is the internal customer account ID.
2Size in bytes of the graph data.
1875150634884086800OK response.
The unique identifier for the data
dc538c61-de48-4220-958c-5f3c4f983daaPre-rendered message included when policy evaluation did not pass
- instance type 'xlarge' is not permittedThe overall status of policy evaluation (if it occurred) indicating whether it passed
errorPossible values: BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
POST /api/orgs/{org}/projects/{project}/workspaces/{workspace}/dependency-graph?pipeline_id=Quasi+omnis.&stage_id=Voluptas+nostrum+harum.&pipeline_execution_id=Est+omnis+excepturi+magnam+nihil.&pipeline_stage_id=Vitae+sit+maxime+esse+quaerat.&provisioner_type=awscdk&data_type=cost_breakdown HTTP/1.1
Host: localhost:80
Harness-Account: 2
Accept: */*
{
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"policy_evaluation": [
{
"message": "Labore quas debitis numquam voluptatem et.",
"policy_id": "Quisquam eos tempore amet aliquid molestias quisquam.",
"policy_name": "Eum accusantium soluta ab non fugiat.",
"policy_set_id": "Aut nihil quas est aspernatur illo qui.",
"policy_set_name": "Autem dolorum itaque.",
"policy_status": "Esse porro alias dolorem."
},
{
"message": "Labore quas debitis numquam voluptatem et.",
"policy_id": "Quisquam eos tempore amet aliquid molestias quisquam.",
"policy_name": "Eum accusantium soluta ab non fugiat.",
"policy_set_id": "Aut nihil quas est aspernatur illo qui.",
"policy_set_name": "Autem dolorum itaque.",
"policy_status": "Esse porro alias dolorem."
}
],
"policy_evaluation_message": "- instance type 'xlarge' is not permitted",
"policy_evaluation_status": "error"
}Returns whether drift automation is enabled and related metadata.
Org is the organisation identifier.
kProject is the project identifier.
zlyWorkspace identifier
Aut voluptatem provident placeat et.Provisioner key (defaults to opentofu when omitted)
Cumque quia laboriosam.Account is the internal customer account ID.
4vnOK response.
trueVoluptas esse est laudantium placeat assumenda praesentium.Repeat interval; set when schedule is configured
4184236585078549500hours or days
minutesPossible values: Culpa laudantium.BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/workspaces/{workspace}/drift-config HTTP/1.1
Host: localhost:80
Harness-Account: 4vn
Accept: */*
{
"enabled": false,
"pipeline_id": "Placeat in ut optio beatae.",
"run_every": 8270720439580752000,
"run_every_unit": "hours",
"trigger_id": "Quia aliquid eum voluptatem eum praesentium."
}Configures drift detection pipeline and schedule for the workspace.
Org is the organisation identifier.
20nProject is the project identifier.
cucWorkspace identifier
Repudiandae id repudiandae temporibus impedit.Account is the internal customer account ID.
14Pipeline to run for drift detection
Sint dolor repudiandae cupiditate enim vero.Provisioner key (defaults to opentofu when omitted)
Est veritatis possimus voluptas.Run drift detection every N hours or N days (see run_every_unit)
5886057759804457000hours or days
minutesPossible values: OK response.
Outcome message
Vel fugit praesentium quia repudiandae laudantium.BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
PUT /api/orgs/{org}/projects/{project}/workspaces/{workspace}/drift-config HTTP/1.1
Host: localhost:80
Harness-Account: 14
Content-Type: application/json
Accept: */*
Content-Length: 117
{
"pipeline_id": "Qui est.",
"provisioner": "Nam cupiditate.",
"run_every": 3273270546498937000,
"run_every_unit": "seconds"
}{
"status": "Officiis labore explicabo repellendus."
}Removes drift scheduling and related configuration for the workspace.
Org is the organisation identifier.
q9rProject is the project identifier.
riWorkspace identifier
Rem accusantium sit consequuntur aperiam.Provisioner key (defaults to opentofu when omitted)
Similique est.Account is the internal customer account ID.
xOK response.
Outcome message
Dolor repellendus.BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
DELETE /api/orgs/{org}/projects/{project}/workspaces/{workspace}/drift-config HTTP/1.1
Host: localhost:80
Harness-Account: x
Accept: */*
{
"status": "Laudantium aliquid id vitae assumenda nulla laudantium."
}Returns whether ephemeral TTL is enabled and related metadata.
Org is the organisation identifier.
lProject is the project identifier.
mp3Workspace identifier
Ut recusandae temporibus.Provisioner key (defaults to opentofu when omitted)
Voluptas dolores voluptate.Account is the internal customer account ID.
0rOK response.
Scheduled deletion timestamp (ISO 8601)
Reiciendis perspiciatis qui vel voluptatum sed ullam.Configured delete delay unit (hours or days)
minutesPossible values: Configured delete delay value (when delete_workspace is true)
2706128422877483500Configured delete date (YYYY-MM-DD) when schedule uses a specific date
Nulla aspernatur ut.Whether workspace will be deleted after destroy
falseScheduled destruction timestamp (ISO 8601)
Eaque qui.Configured destroy date (YYYY-MM-DD) when schedule uses a specific date
Distinctio non sint modi aut.falseTotam aut neque illo consequatur soluta qui.Provisioner this configuration applies to
Dolor quam similique eos est.Origin of the configuration: 'workspace', 'project', or 'disabled'
disabledPossible values: Harness trigger ID for the destroy schedule
Quam nostrum perferendis.Configured destroy delay unit (hours or days)
hoursPossible values: Configured destroy delay value (when schedule uses delay)
7326045953744029000BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/workspaces/{workspace}/ephemeral-config HTTP/1.1
Host: localhost:80
Harness-Account: 0r
Accept: */*
{
"delete_at": "Adipisci consequatur.",
"delete_delay_unit": "days",
"delete_delay_value": 2116444084967232500,
"delete_on_date": "Id voluptatibus iusto.",
"delete_workspace": true,
"destroy_at": "Voluptatem officiis.",
"destroy_on_date": "Necessitatibus non qui.",
"enabled": true,
"pipeline_id": "Temporibus sit doloremque non non qui eaque.",
"provisioner": "Et minus non.",
"source": "project",
"trigger_id": "Accusantium ipsa rem.",
"ttl_unit": "seconds",
"ttl_value": 3227786807564693500
}Configures time-to-live settings to automatically destroy infrastructure and optionally delete the workspace.
Org is the organisation identifier.
ue8Project is the project identifier.
6usWorkspace identifier
Ad qui aspernatur ipsam sed est officiis.Account is the internal customer account ID.
hUnit for delete delay
hoursPossible values: Delete workspace after N hours or days from now
8313731668352711000Specific date to delete workspace (ISO 8601 format, e.g. 2026-09-02)
Qui delectus aut.Whether to delete the workspace record after infrastructure is destroyed
trueUnit for destroy delay
minutesPossible values: Destroy infrastructure after N hours or days from now
7049556480123648000Specific date to destroy infrastructure (ISO 8601 format, e.g. 2026-08-24)
Optio quidem recusandae nam eaque tenetur.Pipeline to run for destroying infrastructure
Aut quas aut commodi accusamus.Provisioner key (defaults to opentofu when omitted)
Occaecati placeat ut.OK response.
Computed delete timestamp (ISO 8601), empty if delete_workspace is false
Quis et aut.Computed destroy timestamp (ISO 8601)
Optio inventore.Outcome message
Soluta tenetur.BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
PUT /api/orgs/{org}/projects/{project}/workspaces/{workspace}/ephemeral-config HTTP/1.1
Host: localhost:80
Harness-Account: h
Content-Type: application/json
Accept: */*
Content-Length: 386
{
"delete_delay_unit": "seconds",
"delete_delay_value": 3451809659308056600,
"delete_on_date": "Ipsum provident perspiciatis.",
"delete_workspace": false,
"destroy_delay_unit": "seconds",
"destroy_delay_value": 6188438809253081000,
"destroy_on_date": "Molestias porro corporis nisi laborum sit.",
"pipeline_id": "Velit commodi ut quia nesciunt.",
"provisioner": "Doloribus illum qui vel qui doloremque."
}{
"delete_at": "Voluptas temporibus veniam aut velit et laudantium.",
"destroy_at": "Voluptatem sed in impedit vel qui.",
"status": "Vel quo suscipit qui sed."
}Removes ephemeral scheduling and related configuration for the workspace.
Org is the organisation identifier.
gProject is the project identifier.
eWorkspace identifier
Libero porro omnis deserunt consequatur non.Provisioner key (defaults to opentofu when omitted)
Ut repellat et ut praesentium fugit.Account is the internal customer account ID.
h9xOK response.
Outcome message
Fugit ducimus reiciendis eum.BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
DELETE /api/orgs/{org}/projects/{project}/workspaces/{workspace}/ephemeral-config HTTP/1.1
Host: localhost:80
Harness-Account: h9x
Accept: */*
{
"status": "Quae dolores velit temporibus aut sed praesentium."
}Store binary data generated by the provisioner, such as plans and state files.
Org is the organisation identifier.
5edProject is the project identifier.
bmWorkspace associated with this event
92Account is the internal customer account ID.
4The type of event that occurred
apply_neededPossible values: Deprecated: use metadata instead
""Example: Beatae sed numquam molestiae labore ullam rem.Deprecated: use metadata instead
""Example: Rem in incidunt quia sed.OK response.
No content
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
POST /api/orgs/{org}/projects/{project}/workspaces/{workspace}/events HTTP/1.1
Host: localhost:80
Harness-Account: 4
Content-Type: application/json
Accept: */*
Content-Length: 10264
{
"data": {
"Autem velit.": "Labore est totam voluptas.",
"Distinctio iste adipisci et recusandae.": "Ad enim quis fuga.",
"Ipsum dignissimos.": "Ut delectus."
},
"event_type": "destroying",
"metadata": {
"PlannedChangesCount": 6287286051821949000,
"activity_status": "success",
"activity_type": "apply",
"cost_breakdown_uuid": "Tempora sapiente nemo dolor voluptatem quia labore.",
"cost_currency": "Neque dicta quasi quia omnis nobis tempore.",
"cost_diff_total_monthly": "Architecto quia ut ratione earum impedit sed.",
"cost_diff_uuid": "Adipisci odio.",
"cost_past_total_monthly": "Vitae perferendis incidunt aut assumenda et.",
"cost_total_monthly": "Ea quia.",
"cost_total_monthly_percentage_change": "Quisquam enim rem similique.",
"data_length": 4911400943199001000,
"drift_counts": {
"added": 2737275095070377000,
"changed": 3189160904069314600,
"deleted": 4609501253999804000,
"imported": 8048488091296873000,
"removed": 591961175117043600,
"unchanged": 6176175569340644000
},
"enable_solutions_factory": false,
"git_branch": "Dicta voluptas tempora sit.",
"git_commit_message": "Dolorem et adipisci.",
"git_commit_sha": "Labore et nisi perferendis accusantium a eum.",
"git_repo": "Beatae non veniam beatae officia.",
"modules_uuid": "Facilis sunt.",
"output_counts": {
"added": 2737275095070377000,
"changed": 3189160904069314600,
"deleted": 4609501253999804000,
"imported": 8048488091296873000,
"removed": 591961175117043600,
"unchanged": 6176175569340644000
},
"pipeline": "Aliquid placeat beatae hic.",
"pipeline_execution_id": "Magnam rerum est ducimus qui earum.",
"pipeline_execution_number": "Et nobis quod ut necessitatibus deserunt qui.",
"pipeline_name": "Sequi consequatur veritatis aut adipisci temporibus.",
"pipeline_stage_id": "Ex inventore numquam recusandae et.",
"plan_uuid": "Eos dolorem.",
"providers_uuid": "Porro tempora.",
"provisioner": "Fugiat temporibus laudantium debitis.",
"provisioner_version": "Repellendus modi eum voluptas ut animi.",
"resource_counts": {
"added": 2737275095070377000,
"changed": 3189160904069314600,
"deleted": 4609501253999804000,
"imported": 8048488091296873000,
"removed": 591961175117043600,
"unchanged": 6176175569340644000
},
"rollback_reason": "Neque illum quod error consequatur cumque nihil.",
"rollback_source_id": "Deleniti numquam et ea unde ut illo.",
"stacks": [
{
"assets_uuid": "Quos enim ut.",
"drift_counts": {
"added": 2737275095070377000,
"changed": 3189160904069314600,
"deleted": 4609501253999804000,
"imported": 8048488091296873000,
"removed": 591961175117043600,
"unchanged": 6176175569340644000
},
"drift_uuid": "Cum rerum iste qui qui commodi.",
"error_message": "Quisquam animi non reiciendis sit deserunt.",
"manifest_uuid": "Eligendi sint minima.",
"resource_counts": {
"added": 2737275095070377000,
"changed": 3189160904069314600,
"deleted": 4609501253999804000,
"imported": 8048488091296873000,
"removed": 591961175117043600,
"unchanged": 6176175569340644000
},
"stack_name": "Enim esse nam cupiditate consequatur maiores nemo.",
"stack_outputs": {
"Dolorem facere laboriosam et.": "Eaque accusantium ea quo quae unde.",
"Laudantium quibusdam voluptatem illum rerum voluptatem non.": "Fuga ipsum.",
"Sed saepe.": "Laborum eos magnam sed et et."
},
"stack_path": "Error nisi sunt laudantium voluptatem earum.",
"status": "success",
"template_uuid": "Odit et sed est officia maxime eum.",
"tree_uuid": "Quisquam non magni ut velit."
},
{
"assets_uuid": "Quos enim ut.",
"drift_counts": {
"added": 2737275095070377000,
"changed": 3189160904069314600,
"deleted": 4609501253999804000,
"imported": 8048488091296873000,
"removed": 591961175117043600,
"unchanged": 6176175569340644000
},
"drift_uuid": "Cum rerum iste qui qui commodi.",
"error_message": "Quisquam animi non reiciendis sit deserunt.",
"manifest_uuid": "Eligendi sint minima.",
"resource_counts": {
"added": 2737275095070377000,
"changed": 3189160904069314600,
"deleted": 4609501253999804000,
"imported": 8048488091296873000,
"removed": 591961175117043600,
"unchanged": 6176175569340644000
},
"stack_name": "Enim esse nam cupiditate consequatur maiores nemo.",
"stack_outputs": {
"Dolorem facere laboriosam et.": "Eaque accusantium ea quo quae unde.",
"Laudantium quibusdam voluptatem illum rerum voluptatem non.": "Fuga ipsum.",
"Sed saepe.": "Laborum eos magnam sed et et."
},
"stack_path": "Error nisi sunt laudantium voluptatem earum.",
"status": "success",
"template_uuid": "Odit et sed est officia maxime eum.",
"tree_uuid": "Quisquam non magni ut velit."
},
{
"assets_uuid": "Quos enim ut.",
"drift_counts": {
"added": 2737275095070377000,
"changed": 3189160904069314600,
"deleted": 4609501253999804000,
"imported": 8048488091296873000,
"removed": 591961175117043600,
"unchanged": 6176175569340644000
},
"drift_uuid": "Cum rerum iste qui qui commodi.",
"error_message": "Quisquam animi non reiciendis sit deserunt.",
"manifest_uuid": "Eligendi sint minima.",
"resource_counts": {
"added": 2737275095070377000,
"changed": 3189160904069314600,
"deleted": 4609501253999804000,
"imported": 8048488091296873000,
"removed": 591961175117043600,
"unchanged": 6176175569340644000
},
"stack_name": "Enim esse nam cupiditate consequatur maiores nemo.",
"stack_outputs": {
"Dolorem facere laboriosam et.": "Eaque accusantium ea quo quae unde.",
"Laudantium quibusdam voluptatem illum rerum voluptatem non.": "Fuga ipsum.",
"Sed saepe.": "Laborum eos magnam sed et et."
},
"stack_path": "Error nisi sunt laudantium voluptatem earum.",
"status": "success",
"template_uuid": "Odit et sed est officia maxime eum.",
"tree_uuid": "Quisquam non magni ut velit."
},
{
"assets_uuid": "Quos enim ut.",
"drift_counts": {
"added": 2737275095070377000,
"changed": 3189160904069314600,
"deleted": 4609501253999804000,
"imported": 8048488091296873000,
"removed": 591961175117043600,
"unchanged": 6176175569340644000
},
"drift_uuid": "Cum rerum iste qui qui commodi.",
"error_message": "Quisquam animi non reiciendis sit deserunt.",
"manifest_uuid": "Eligendi sint minima.",
"resource_counts": {
"added": 2737275095070377000,
"changed": 3189160904069314600,
"deleted": 4609501253999804000,
"imported": 8048488091296873000,
"removed": 591961175117043600,
"unchanged": 6176175569340644000
},
"stack_name": "Enim esse nam cupiditate consequatur maiores nemo.",
"stack_outputs": {
"Dolorem facere laboriosam et.": "Eaque accusantium ea quo quae unde.",
"Laudantium quibusdam voluptatem illum rerum voluptatem non.": "Fuga ipsum.",
"Sed saepe.": "Laborum eos magnam sed et et."
},
"stack_path": "Error nisi sunt laudantium voluptatem earum.",
"status": "success",
"template_uuid": "Odit et sed est officia maxime eum.",
"tree_uuid": "Quisquam non magni ut velit."
}
],
"state_checksum": "Minima nisi qui aspernatur voluptatem voluptate est.",
"state_uuid": "Minima placeat provident maiores odio officia.",
"terragrunt_details": [
{
"cost_breakdown_uuid": "Repellat libero expedita non nemo veritatis.",
"cost_currency": "Accusamus laborum voluptatem quo iusto dolores.",
"cost_diff_total_monthly": "Iure similique est.",
"cost_diff_uuid": "Odio autem possimus excepturi.",
"cost_past_total_monthly": "Quisquam dolor tempora exercitationem facilis.",
"cost_total_monthly": "Vel cum dolorum atque cumque.",
"cost_total_monthly_percentage_change": "Cumque veniam.",
"drift_counts": {
"added": 2737275095070377000,
"changed": 3189160904069314600,
"deleted": 4609501253999804000,
"imported": 8048488091296873000,
"removed": 591961175117043600,
"unchanged": 6176175569340644000
},
"output_counts": {
"added": 2737275095070377000,
"changed": 3189160904069314600,
"deleted": 4609501253999804000,
"imported": 8048488091296873000,
"removed": 591961175117043600,
"unchanged": 6176175569340644000
},
"path_id": "Maiores excepturi facilis reprehenderit cupiditate dicta.",
"resource_counts": {
"added": 2737275095070377000,
"changed": 3189160904069314600,
"deleted": 4609501253999804000,
"imported": 8048488091296873000,
"removed": 591961175117043600,
"unchanged": 6176175569340644000
},
"state_file_link": "Ea voluptas minima pariatur laudantium.",
"status": "Architecto quis enim numquam pariatur."
},
{
"cost_breakdown_uuid": "Repellat libero expedita non nemo veritatis.",
"cost_currency": "Accusamus laborum voluptatem quo iusto dolores.",
"cost_diff_total_monthly": "Iure similique est.",
"cost_diff_uuid": "Odio autem possimus excepturi.",
"cost_past_total_monthly": "Quisquam dolor tempora exercitationem facilis.",
"cost_total_monthly": "Vel cum dolorum atque cumque.",
"cost_total_monthly_percentage_change": "Cumque veniam.",
"drift_counts": {
"added": 2737275095070377000,
"changed": 3189160904069314600,
"deleted": 4609501253999804000,
"imported": 8048488091296873000,
"removed": 591961175117043600,
"unchanged": 6176175569340644000
},
"output_counts": {
"added": 2737275095070377000,
"changed": 3189160904069314600,
"deleted": 4609501253999804000,
"imported": 8048488091296873000,
"removed": 591961175117043600,
"unchanged": 6176175569340644000
},
"path_id": "Maiores excepturi facilis reprehenderit cupiditate dicta.",
"resource_counts": {
"added": 2737275095070377000,
"changed": 3189160904069314600,
"deleted": 4609501253999804000,
"imported": 8048488091296873000,
"removed": 591961175117043600,
"unchanged": 6176175569340644000
},
"state_file_link": "Ea voluptas minima pariatur laudantium.",
"status": "Architecto quis enim numquam pariatur."
},
{
"cost_breakdown_uuid": "Repellat libero expedita non nemo veritatis.",
"cost_currency": "Accusamus laborum voluptatem quo iusto dolores.",
"cost_diff_total_monthly": "Iure similique est.",
"cost_diff_uuid": "Odio autem possimus excepturi.",
"cost_past_total_monthly": "Quisquam dolor tempora exercitationem facilis.",
"cost_total_monthly": "Vel cum dolorum atque cumque.",
"cost_total_monthly_percentage_change": "Cumque veniam.",
"drift_counts": {
"added": 2737275095070377000,
"changed": 3189160904069314600,
"deleted": 4609501253999804000,
"imported": 8048488091296873000,
"removed": 591961175117043600,
"unchanged": 6176175569340644000
},
"output_counts": {
"added": 2737275095070377000,
"changed": 3189160904069314600,
"deleted": 4609501253999804000,
"imported": 8048488091296873000,
"removed": 591961175117043600,
"unchanged": 6176175569340644000
},
"path_id": "Maiores excepturi facilis reprehenderit cupiditate dicta.",
"resource_counts": {
"added": 2737275095070377000,
"changed": 3189160904069314600,
"deleted": 4609501253999804000,
"imported": 8048488091296873000,
"removed": 591961175117043600,
"unchanged": 6176175569340644000
},
"state_file_link": "Ea voluptas minima pariatur laudantium.",
"status": "Architecto quis enim numquam pariatur."
}
],
"trigger": {
"Beatae et consequatur.": "Et laborum."
}
},
"pipeline_execution_id": "Suscipit voluptatem aut fuga et aliquid.",
"pipeline_stage_id": "Voluptatem nemo et exercitationem eveniet."
}No content
List the pipelines where the workspace is been used
Org is the organisation identifier.
qcaProject is the project identifier.
jWorkspace identifier
Qui est quo odit a quibusdam voluptas.Limit is the number of records to return for a page.
30Example: 30Page is the page number to return relative to the page 'limit'.
1Example: 1Account is the internal customer account ID.
uoOK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/workspaces/{workspace}/pipelines HTTP/1.1
Host: localhost:80
Harness-Account: uo
Accept: */*
{
"account": "48p",
"org": "3qi",
"pipelines": [
"Sit dolore quia.",
"Est a sint dolores autem et.",
"Tenetur occaecati aut error dolores neque."
],
"project": "i"
}Create a remote execution for a workspace.
Org is the organisation identifier.
gProject is the project identifier.
66dThe workspace associated with the remote execution.
Ut quaerat id voluptatibus laborum provident facilis.Account is the internal customer account ID.
e5sCreated response.
Account is the internal customer account ID.
7vCreated is the unix timestamp at which the resource was originally created in milliseconds.
6780445067469863000The boolean value indicating if the remote execution has been executed.
falseThe ID of the remote execution.
f80c7016-ab07-49c2-b03d-4152e10aa4a0Org is the organisation identifier.
508The pipeline execution ID of the pipeline executing the remote execution
Consequatur et nisi.The pipeline execution URL of the pipeline executing the remote execution
Et quis ut.Project is the project identifier.
r3dThe checksum of the patch file of changes that the remote execution will run against.
Iusto voluptas consequuntur.Modified is the unix timestamp at which the resource was last modified in milliseconds.
3088580093997148700The workspace associated with the remote execution.
Et voluptatem saepe.BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
POST /api/orgs/{org}/projects/{project}/workspaces/{workspace}/remote-executions HTTP/1.1
Host: localhost:80
Harness-Account: e5s
Content-Type: application/json
Accept: */*
Content-Length: 289
{
"custom_arguments": {
"Officiis et repellat.": [
"Nihil dolor sequi praesentium.",
"Explicabo pariatur maxime omnis qui nisi.",
"Ut nulla aut et.",
"Saepe facilis."
],
"Quia repudiandae modi rerum aspernatur.": [
"Voluptas architecto eum voluptatum quia sit et.",
"Et sit ea deserunt adipisci et."
]
}
}{
"account": "5j",
"created": 2923362080410904000,
"custom_arguments": {
"Enim quibusdam soluta minus aut.": [
"Commodi exercitationem numquam deleniti.",
"Aliquam qui sunt quos.",
"Ipsam est qui quidem tenetur.",
"Ipsam ullam ut aut alias vel."
]
},
"executed": true,
"id": "6d0a8798-7dd0-48a1-b8ff-edddd0f6f11e",
"org": "u",
"pipeline_execution_id": "Consequatur perferendis dignissimos minus.",
"pipeline_execution_url": "Consequuntur aut.",
"project": "qr",
"sha256_checksum": "Sequi repudiandae quam eligendi ab deleniti.",
"updated": 6950789718625565000,
"workspace": "Tempora sequi."
}Find remote execution
Org is the organisation identifier.
4wcProject is the project identifier.
t1dWorkspace is the resource workspace this variable is associated with.
Aspernatur iusto aut quam.The ID of the remote execution
2578aa44-5c1d-42e3-b8ad-1bbbc091c0bcAccount is the internal customer account ID.
qOK response.
Account is the internal customer account ID.
ypCreated is the unix timestamp at which the resource was originally created in milliseconds.
2168203252567040000The boolean value indicating if the remote execution has been executed.
trueThe ID of the remote execution.
5d3dccf0-e704-476d-8114-379124e8c952Org is the organisation identifier.
m05The pipeline execution ID of the pipeline executing the remote execution
Aliquid nulla rerum veritatis libero cum.The pipeline execution URL of the pipeline executing the remote execution
Sed ab.Project is the project identifier.
tlxThe checksum of the patch file of changes that the remote execution will run against.
Neque eum.Modified is the unix timestamp at which the resource was last modified in milliseconds.
2783501292935401500The workspace associated with the remote execution.
Laboriosam exercitationem quas in beatae facilis.BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/workspaces/{workspace}/remote-executions/{id} HTTP/1.1
Host: localhost:80
Harness-Account: q
Accept: */*
{
"account": "s",
"created": 5846184400883632000,
"custom_arguments": {
"Consequuntur voluptatibus ut.": [
"Reiciendis harum minima laboriosam velit accusantium sed.",
"Reprehenderit qui et.",
"Veritatis amet voluptatum a.",
"Corporis exercitationem laboriosam voluptate natus qui voluptas."
],
"Sunt sunt.": [
"Sit et aut qui.",
"Placeat nisi consequatur sunt voluptates.",
"Quo neque dicta suscipit rerum."
]
},
"executed": false,
"id": "04d592f9-b0b1-4ece-91ce-47b7e5cd7862",
"org": "up",
"pipeline_execution_id": "Laudantium quisquam et in aut iusto.",
"pipeline_execution_url": "Sit officia.",
"project": "jm",
"sha256_checksum": "Ut cupiditate aut quia facere voluptas.",
"updated": 2925468222543709700,
"workspace": "Voluptates explicabo unde adipisci praesentium."
}Download the source code for the remote plan.
Org is the organisation identifier.
cb5Project is the project identifier.
zpWorkspace is the resource workspace this variable is associated with.
Excepturi quis possimus maxime omnis aliquid in.The ID of the remote execution
6970355f-2b67-423f-a90c-989a66fa3155Account is the internal customer account ID.
bOK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/workspaces/{workspace}/remote-executions/{id}/download HTTP/1.1
Host: localhost:80
Harness-Account: b
Accept: */*
binaryExecute the remote execution
Org is the organisation identifier.
un6Project is the project identifier.
nvkWorkspace is the resource workspace this variable is associated with.
Eum ipsa.The ID of the remote execution
dbb1a2f5-ef89-4993-ab84-2d196a463064Account is the internal customer account ID.
bycOK response.
remote execution details for a specific workspace.
Account is the internal customer account ID.
dCreated is the unix timestamp at which the resource was originally created in milliseconds.
373953134849103600The boolean value indicating if the remote execution has been executed.
trueThe ID of the remote execution.
b60bf3d4-c07a-4ae5-a9aa-d202f44e91a2Org is the organisation identifier.
inThe pipeline execution ID of the pipeline executing the remote execution
Rem et unde alias consectetur qui.The pipeline execution URL of the pipeline executing the remote execution
Velit quis laborum facere qui et nulla.Project is the project identifier.
pThe checksum of the patch file of changes that the remote execution will run against.
Voluptatem pariatur reprehenderit.Modified is the unix timestamp at which the resource was last modified in milliseconds.
370283931129504300The workspace associated with the remote execution.
Qui sit quasi.BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
POST /api/orgs/{org}/projects/{project}/workspaces/{workspace}/remote-executions/{id}/execute HTTP/1.1
Host: localhost:80
Harness-Account: byc
Accept: */*
{
"account": "eba",
"created": 1746185806223233000,
"custom_arguments": {
"Earum cumque tempora.": [
"Sit et possimus.",
"Quas commodi odio possimus iusto est.",
"Ut rerum provident ipsum consequatur recusandae.",
"Explicabo in est distinctio quis dignissimos."
],
"Et vel odio quia est est aliquid.": [
"Sit et aspernatur delectus ducimus alias illo.",
"Iste esse qui dolores quibusdam.",
"Sed et distinctio sapiente occaecati est."
],
"Qui sed corrupti nam expedita praesentium et.": [
"Optio natus ut minus.",
"Dolores rerum iure vero aliquam exercitationem.",
"Deleniti asperiores dolorem."
]
},
"executed": false,
"id": "1559929f-31be-406f-a2ab-d108b3982172",
"org": "k",
"pipeline_execution_id": "Molestiae officia adipisci consequuntur et architecto.",
"pipeline_execution_url": "Commodi placeat veritatis.",
"project": "3v3",
"sha256_checksum": "Beatae est.",
"updated": 3602521834027049000,
"workspace": "Ut sit minima eos est laboriosam."
}Upload the source code for the remote execution.
Org is the organisation identifier.
dProject is the project identifier.
n2Workspace is the resource workspace this variable is associated with.
Nihil quia esse corrupti veniam qui.The ID of the remote execution
01de0920-2339-407d-8d99-9d2f78fa69e1Account is the internal customer account ID.
sSize in bytes of the source code.
4378301106325908500Content-Digest header as defined in https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Digest. Sha256 is the only supported algorithm.
Itaque dolores ut voluptatem.OK response.
Account is the internal customer account ID.
asCreated is the unix timestamp at which the resource was originally created in milliseconds.
613070183896880400The boolean value indicating if the remote execution has been executed.
falseThe ID of the remote execution.
e893f6c6-54dd-4ebd-9d19-389c9a90f1e5Org is the organisation identifier.
jThe pipeline execution ID of the pipeline executing the remote execution
Veniam culpa laudantium.The pipeline execution URL of the pipeline executing the remote execution
Blanditiis ea reiciendis nemo sunt.Project is the project identifier.
f4The checksum of the patch file of changes that the remote execution will run against.
Est vel.Modified is the unix timestamp at which the resource was last modified in milliseconds.
470833627133889660The workspace associated with the remote execution.
Voluptatem architecto nobis consequuntur.BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
POST /api/orgs/{org}/projects/{project}/workspaces/{workspace}/remote-executions/{id}/upload HTTP/1.1
Host: localhost:80
Harness-Account: s
Content-Digest: Itaque dolores ut voluptatem.
Accept: */*
{
"account": "w0b",
"created": 5931500354233517000,
"custom_arguments": {
"Occaecati facere vel ut.": [
"Inventore non.",
"Odio voluptatem fugiat.",
"Totam vitae consequatur beatae."
],
"Veniam veniam sapiente beatae voluptas molestias modi.": [
"Id sed placeat est rerum laboriosam.",
"Et natus."
]
},
"executed": true,
"id": "c51f0e7e-e7b3-4bf8-a3a8-18ea9271db3c",
"org": "zl",
"pipeline_execution_id": "Quae inventore explicabo et esse corrupti.",
"pipeline_execution_url": "Exercitationem recusandae aspernatur.",
"project": "nv",
"sha256_checksum": "Tenetur minima reiciendis aliquam sit.",
"updated": 3462074111333053400,
"workspace": "Nulla architecto eum dolores."
}Retrieves the resource types used by workspaces
Org is the organisation identifier.
puzProject is the project identifier.
s1Workspace identifier
Perferendis est.Account is the internal customer account ID.
0OK response.
List of resource types
["Praesentium eum quo.","Qui ut.","Quae asperiores tempora suscipit perspiciatis voluptatem modi.","Incidunt asperiores autem aut fuga eos totam."]BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/workspaces/{workspace}/resource-types HTTP/1.1
Host: localhost:80
Harness-Account: 0
Accept: */*
[
"At dicta harum suscipit dolores nisi explicabo.",
"Repellat illo aliquid vero recusandae commodi omnis."
]Retrieves the resource type attributes used by workspaces and attributes
Org is the organisation identifier.
xhlProject is the project identifier.
1uWorkspace identifier
Molestiae assumenda.Account is the internal customer account ID.
0OK response.
Map of resource types and their attributes
["Facilis consequatur alias.","Nemo dolores culpa.","Libero facilis et quibusdam quidem."]BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/workspaces/{workspace}/resource-types-and-attributes HTTP/1.1
Host: localhost:80
Harness-Account: 0
Accept: */*
{
"Eos fugiat minima provident.": [
"Qui perspiciatis nulla iure et dolore.",
"Veritatis a eaque quod voluptatum fuga.",
"Ut labore repudiandae."
]
}Retrieves the resource type attributes used by workspaces
Org is the organisation identifier.
3kProject is the project identifier.
iWorkspace identifier
Deserunt praesentium ut earum cumque sunt.Resource type
At possimus inventore.Account is the internal customer account ID.
noyOK response.
List of resource type attributes
["Amet sit cupiditate exercitationem.","Laboriosam aut.","Necessitatibus aliquam.","Et voluptas quae expedita et est ipsa."]BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/workspaces/{workspace}/resource-types/{resource_type}/attributes HTTP/1.1
Host: localhost:80
Harness-Account: noy
Accept: */*
[
"Repellendus inventore accusantium vel consequatur occaecati dolor.",
"Incidunt magni blanditiis occaecati id assumenda esse.",
"Minus vel ut.",
"Dolorem qui."
]Deletes destroyed resources for a workspace.
Org is the organisation identifier.
lodProject is the project identifier.
nWorkspace identifier
Quia voluptate pariatur.Account is the internal customer account ID.
49dOK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
DELETE /api/orgs/{org}/projects/{project}/workspaces/{workspace}/resources HTTP/1.1
Host: localhost:80
Harness-Account: 49d
Content-Type: application/json
Accept: */*
Content-Length: 919
{
"resources": [
{
"module": "Sit molestias.",
"name": "Distinctio iure animi facilis accusantium.",
"path_id": "Nihil earum.",
"provider": "Eveniet iusto numquam voluptatem quia et provident.",
"type": "Omnis cumque aliquam placeat ut saepe ducimus."
},
{
"module": "Sit molestias.",
"name": "Distinctio iure animi facilis accusantium.",
"path_id": "Nihil earum.",
"provider": "Eveniet iusto numquam voluptatem quia et provident.",
"type": "Omnis cumque aliquam placeat ut saepe ducimus."
},
{
"module": "Sit molestias.",
"name": "Distinctio iure animi facilis accusantium.",
"path_id": "Nihil earum.",
"provider": "Eveniet iusto numquam voluptatem quia et provident.",
"type": "Omnis cumque aliquam placeat ut saepe ducimus."
},
{
"module": "Sit molestias.",
"name": "Distinctio iure animi facilis accusantium.",
"path_id": "Nihil earum.",
"provider": "Eveniet iusto numquam voluptatem quia et provident.",
"type": "Omnis cumque aliquam placeat ut saepe ducimus."
}
]
}{
"results": [
{
"error": "A similique quibusdam incidunt officiis.",
"module": "Eaque facilis.",
"name": "Illum est ut neque laborum.",
"provider": "Voluptas magnam ut animi voluptatibus.",
"status": "skipped",
"type": "Nesciunt aperiam similique adipisci dignissimos exercitationem."
},
{
"error": "A similique quibusdam incidunt officiis.",
"module": "Eaque facilis.",
"name": "Illum est ut neque laborum.",
"provider": "Voluptas magnam ut animi voluptatibus.",
"status": "skipped",
"type": "Nesciunt aperiam similique adipisci dignissimos exercitationem."
}
],
"summary": {
"deleted": 6644572953107601000,
"failed": 1083001572762766100,
"skipped": 8213593984185752000,
"total": 1926069642079262000
}
}Updates resources for a workspace.
Org is the organisation identifier.
cProject is the project identifier.
0woWorkspace identifier
Omnis voluptate perspiciatis beatae quia ab.Account is the internal customer account ID.
hSession ID to track resource updates belongs to same operation
5d07809c-9e8e-4774-8d69-da3689710ab1Update mode: upsert (default) updates attributes; drift updates drift columns only
upsertExample: driftPossible values: OK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
PATCH /api/orgs/{org}/projects/{project}/workspaces/{workspace}/resources HTTP/1.1
Host: localhost:80
Harness-Account: h
Content-Type: application/json
Accept: */*
Content-Length: 1746
{
"resources": [
{
"attributes": "Explicabo qui.",
"drift_attributes": {
"Earum omnis et.": "Optio iusto cum veritatis."
},
"drift_status": "unchanged",
"mode": "Rem qui magni rem ratione et.",
"module": "Adipisci maxime saepe ducimus debitis.",
"name": "Et placeat.",
"path_id": "Officiis a eos voluptatem.",
"provider": "Est doloremque.",
"sensitive_attribute_paths": [
"Earum architecto sed laboriosam.",
"Veniam dolores placeat autem in placeat.",
"Quaerat et minus deleniti delectus omnis.",
"Est iste porro eveniet velit sequi."
],
"type": "Explicabo nihil praesentium omnis et molestiae."
},
{
"attributes": "Explicabo qui.",
"drift_attributes": {
"Earum omnis et.": "Optio iusto cum veritatis."
},
"drift_status": "unchanged",
"mode": "Rem qui magni rem ratione et.",
"module": "Adipisci maxime saepe ducimus debitis.",
"name": "Et placeat.",
"path_id": "Officiis a eos voluptatem.",
"provider": "Est doloremque.",
"sensitive_attribute_paths": [
"Earum architecto sed laboriosam.",
"Veniam dolores placeat autem in placeat.",
"Quaerat et minus deleniti delectus omnis.",
"Est iste porro eveniet velit sequi."
],
"type": "Explicabo nihil praesentium omnis et molestiae."
},
{
"attributes": "Explicabo qui.",
"drift_attributes": {
"Earum omnis et.": "Optio iusto cum veritatis."
},
"drift_status": "unchanged",
"mode": "Rem qui magni rem ratione et.",
"module": "Adipisci maxime saepe ducimus debitis.",
"name": "Et placeat.",
"path_id": "Officiis a eos voluptatem.",
"provider": "Est doloremque.",
"sensitive_attribute_paths": [
"Earum architecto sed laboriosam.",
"Veniam dolores placeat autem in placeat.",
"Quaerat et minus deleniti delectus omnis.",
"Est iste porro eveniet velit sequi."
],
"type": "Explicabo nihil praesentium omnis et molestiae."
}
],
"session_id": "af5e596a-58de-4c2f-ad60-4272ee1fb9a0",
"update_mode": "upsert"
}{
"results": [
{
"error": "Ut delectus repellat nemo consequatur omnis rem.",
"mode": "Ipsa omnis ea.",
"module": "Est deserunt dicta corporis recusandae.",
"name": "Autem deserunt voluptas.",
"provider": "Nulla voluptate aliquid et.",
"status": "failed",
"type": "Qui necessitatibus sint."
},
{
"error": "Ut delectus repellat nemo consequatur omnis rem.",
"mode": "Ipsa omnis ea.",
"module": "Est deserunt dicta corporis recusandae.",
"name": "Autem deserunt voluptas.",
"provider": "Nulla voluptate aliquid et.",
"status": "failed",
"type": "Qui necessitatibus sint."
},
{
"error": "Ut delectus repellat nemo consequatur omnis rem.",
"mode": "Ipsa omnis ea.",
"module": "Est deserunt dicta corporis recusandae.",
"name": "Autem deserunt voluptas.",
"provider": "Nulla voluptate aliquid et.",
"status": "failed",
"type": "Qui necessitatibus sint."
}
],
"summary": {
"failed": 8530308004572883000,
"skipped": 7551007554483574000,
"total": 4080830785687873500,
"updated": 1165981821357634000
}
}Deletes stale resources for a workspace that don't belong to the current session.
Org is the organisation identifier.
a2gProject is the project identifier.
yWorkspace identifier
Eaque omnis facere architecto neque et.Account is the internal customer account ID.
dtmCurrent session ID - resources not matching this will be deleted
468dadad-01c3-429f-b57a-64b87273bccaOK response.
Number of stale resources deleted
4950641383897993000BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
DELETE /api/orgs/{org}/projects/{project}/workspaces/{workspace}/resources/stale HTTP/1.1
Host: localhost:80
Harness-Account: dtm
Content-Type: application/json
Accept: */*
Content-Length: 53
{
"session_id": "74cc7cf0-b913-40b9-8909-7fa502354304"
}{
"deleted_count": 8457560113730301000
}Upload per-resource risk data and overall risk summary for an existing plan file.
Org is the organisation identifier.
1aProject is the project identifier.
cWorkspace identifier
workspace123The unique identifier for the associated pipeline
Laborum enim distinctio assumenda sint.The unique identifier for a stage
Tenetur nobis ipsum nihil.The unique identifier for the associated pipeline execution
Quo occaecati tempora ipsam.The unique identifier for the associated pipeline execution stage
Ea molestias dolor.Type of provisioner that created the data
tfPossible values: Type of data stored
cdk_templatePossible values: Optional path to the stack module
Earum corporis nostrum eaque.Account is the internal customer account ID.
m1Size in bytes of the risk data.
5015829674761107000OK response.
The unique identifier for the data
dc538c61-de48-4220-958c-5f3c4f983daaPre-rendered message included when policy evaluation did not pass
- instance type 'xlarge' is not permittedThe overall status of policy evaluation (if it occurred) indicating whether it passed
errorPossible values: BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
POST /api/orgs/{org}/projects/{project}/workspaces/{workspace}/risk-assessment?pipeline_id=Laborum+enim+distinctio+assumenda+sint.&stage_id=Tenetur+nobis+ipsum+nihil.&pipeline_execution_id=Quo+occaecati+tempora+ipsam.&pipeline_stage_id=Ea+molestias+dolor.&provisioner_type=tf&data_type=cdk_template HTTP/1.1
Host: localhost:80
Harness-Account: m1
Accept: */*
{
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"policy_evaluation": [
{
"message": "Labore quas debitis numquam voluptatem et.",
"policy_id": "Quisquam eos tempore amet aliquid molestias quisquam.",
"policy_name": "Eum accusantium soluta ab non fugiat.",
"policy_set_id": "Aut nihil quas est aspernatur illo qui.",
"policy_set_name": "Autem dolorum itaque.",
"policy_status": "Esse porro alias dolorem."
},
{
"message": "Labore quas debitis numquam voluptatem et.",
"policy_id": "Quisquam eos tempore amet aliquid molestias quisquam.",
"policy_name": "Eum accusantium soluta ab non fugiat.",
"policy_set_id": "Aut nihil quas est aspernatur illo qui.",
"policy_set_name": "Autem dolorum itaque.",
"policy_status": "Esse porro alias dolorem."
}
],
"policy_evaluation_message": "- instance type 'xlarge' is not permitted",
"policy_evaluation_status": "error"
}Copies a historical state file to a new version and sets the workspace state pointer to it. Blocked when a pipeline execution is in flight.
Org is the organisation identifier.
pznProject is the project identifier.
kWorkspace identifier
Modi ab possimus rerum provident aut.The unique identifier of the state version to roll back to
d7a1e193-69e0-4998-a95e-847bde74091cAccount is the internal customer account ID.
k6Optional human-readable reason for the rollback
Quas quia laborum ratione quidem cumque.OK response.
The unique identifier of the audit activity record
213e914e-db63-49a1-9b34-52e84efd47e2The unique identifier of the new state version created by the rollback
1a93ef56-222a-4d93-bd28-616041a027c5The file version timestamp (microseconds) of the new state object
6974116809278287000BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
POST /api/orgs/{org}/projects/{project}/workspaces/{workspace}/state-versions/{data_id}/rollback HTTP/1.1
Host: localhost:80
Harness-Account: k6
Content-Type: application/json
Accept: */*
Content-Length: 64
{
"rollback_reason": "Eos sint dignissimos aliquid ratione quos."
}{
"activity_id": "2ebd2015-120f-4a66-a1e4-39b583b9e96d",
"new_data_id": "bdb26b4b-1208-4cbc-ad7d-f7f12ed2420e",
"new_file_version": 1108218460612385900
}Retrieves the ratio of provisioners used by workspaces
Org is the organisation identifier.
obProject is the project identifier.
17Start time filter (Unix timestamp)
3413182767305545700End time filter (Unix timestamp)
1248066571402270500Account is the internal customer account ID.
7OK response.
List of provisioners ratio
Total number of workspaces
0.20175152613000244BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/workspaces/provisioners-ratio HTTP/1.1
Host: localhost:80
Harness-Account: 7
Accept: */*
{
"provisioner": {
"Et et recusandae fugit unde ex sunt.": 0.3253491361153183,
"Quaerat et numquam illum.": 0.5311634618667437,
"Ut quaerat quos aut.": 0.07492339759156615
},
"total": 0.9352788051613689
}Get all workspaces associated with a specific template ID
Template identifier to filter workspaces
4ieOrganization identifier (required for 'org' and 'project' scope).
vnpProject identifier (required for 'project' scope).
5Template version associated with the workspace.
g0eAccount identifier.
vOK response.
List of workspaces associated with the template ID
Account identifier.
mTimestamp when the workspace-template association was created.
1627590400Organization identifier.
nsnProject identifier.
8yTemplate identifier.
a5zTimestamp when the workspace-template association was last updated.
1627686800Template version associated with the workspace.
14eWorkspace identifier.
hBadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/workspace/templates/{template_id} HTTP/1.1
Host: localhost:80
Harness-Account: v
Accept: */*
[
{
"account": "kn",
"created_at": 1627590400,
"org": "4e",
"project": "bjr",
"template_id": "qr4",
"updated_at": 1627686800,
"version": "8h",
"workspace_id": "6p"
},
{
"account": "kn",
"created_at": 1627590400,
"org": "4e",
"project": "bjr",
"template_id": "qr4",
"updated_at": 1627686800,
"version": "8h",
"workspace_id": "6p"
},
{
"account": "kn",
"created_at": 1627590400,
"org": "4e",
"project": "bjr",
"template_id": "qr4",
"updated_at": 1627686800,
"version": "8h",
"workspace_id": "6p"
}
]Last updated
Was this helpful?