openapi: 3.2.0 info: title: Harness Workspaces API version: '1.0' description: The Harness Software Delivery Platform uses OpenAPI Specification v3.0. contact: name: API Support email: contact@harness.io url: https://harness.io/ x-logo: url: https://mma.prnewswire.com/media/779232/Harnes_logo_horizontal.jpg?p=facebook altText: Harness termsOfService: https://harness.io/terms-of-use/ servers: - url: https://app.harness.io description: Harness host URL - url: https://{vanity} description: Vanity URL variables: vanity: default: app.harness.io security: - x-api-key: [] tags: - name: Workspaces description: 'Workspaces Service handles the API for managing workspaces and triggering workflows against them.' paths: /iacm/api/orgs/{org}/projects/{project}/tags: get: tags: - Workspaces summary: List all workspace tags description: List all tags operationId: workspaces#list-all-workspace-tags parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: '1' minLength: 1 maxLength: 128 example: '83' - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: lc minLength: 1 maxLength: 128 example: gt - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: '1' minLength: 1 maxLength: 128 example: lf6 responses: '200': description: OK response. content: application/json: schema: type: array items: type: string example: Sint et voluptatibus voluptatem magnam. example: - Quo placeat vero vel. - Adipisci harum. - Fuga corrupti omnis. example: - Aperiam hic sit et culpa in. - Debitis et. - Aut quas rem nihil qui labore molestiae. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspace-metrics: get: tags: - Workspaces summary: Show workspace metrics description: Show metrics for workspaces operationId: workspaces#show-workspace-metrics parameters: - name: start_time in: query description: Start time filter (Unix timestamp) allowEmptyValue: true schema: type: integer description: Start time filter (Unix timestamp) example: 3702652903170433000 format: int64 example: 2312895160738468400 - name: end_time in: query description: End time filter (Unix timestamp) allowEmptyValue: true schema: type: integer description: End time filter (Unix timestamp) example: 1175252005813441000 format: int64 example: 1453570943024446700 - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: f89 minLength: 1 maxLength: 128 example: x - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: '3' minLength: 1 maxLength: 128 example: s - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: kh minLength: 1 maxLength: 128 example: b responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/ShowWorkspaceMetricsRequest' example: status_counts: Necessitatibus ut minima et aut.: 2399362582700301000 Perspiciatis unde ut consequatur.: 6747443222738879000 Sunt ut maxime rerum qui.: 7043253897266228000 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces: get: tags: - Workspaces summary: List workspaces description: List all workspaces. operationId: workspaces#list-workspaces parameters: - name: limit in: query description: Limit is the number of records to return for a page. allowEmptyValue: true schema: type: integer description: Limit is the number of records to return for a page. default: 30 example: 30 format: int64 minimum: 1 maximum: 1000 example: 30 - name: page in: query description: Page is the page number to return relative to the page 'limit'. allowEmptyValue: true schema: type: integer description: Page is the page number to return relative to the page 'limit'. default: 1 example: 1 format: int64 minimum: 1 example: 1 - name: searchTerm in: query description: Filter results by partial name match allowEmptyValue: true schema: type: string description: Filter results by partial name match default: '' example: mysta example: mysta - name: sort in: query description: Sort order for results allowEmptyValue: true schema: type: string description: Sort order for results default: name,ASC example: name,DESC enum: - name,ASC - name,DESC - updated,ASC - updated,DESC example: name,DESC - name: status in: query description: Status of the execution allowEmptyValue: true schema: type: array items: type: string example: Qui perferendis facilis rem ipsam et. description: Status of the execution example: - Quaerat nam quia. - Nesciunt delectus quasi. example: - Nostrum voluptatibus id libero numquam totam. - Ex iure qui voluptatem. - Enim laudantium est quis id aperiam fuga. - Est a laborum reiciendis reprehenderit aliquid impedit. - name: tags in: query description: Comma separated list of tags to filter by allowEmptyValue: true schema: type: array items: type: string example: Temporibus sed autem tempora asperiores repellendus. description: Comma separated list of tags to filter by example: - Nostrum qui magnam asperiores in. - Praesentium vel ipsum dolorum. example: - Pariatur asperiores aut tempore. - Magnam odit quis nihil quae delectus amet. - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: '1' minLength: 1 maxLength: 128 example: w - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: '5' minLength: 1 maxLength: 128 example: yyj - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: sd minLength: 1 maxLength: 128 example: k0r responses: '200': description: OK response. headers: x-page-size: description: Current page size schema: type: integer description: Current page size example: 50 format: int64 example: 50 x-total-items: description: Total items available schema: type: integer description: Total items available example: 1800 format: int64 example: 1800 x-total-pages: description: Total pages available schema: type: integer description: Total pages available example: 36 format: int64 example: 36 content: application/json: schema: $ref: '#/components/schemas/WorkspaceResourceSummaryCollection' example: - account: tug created: 7506229833280796000 description: this is a more detailed explanation of the resource. identifier: i name: resource name org: gum project: ln status: destroying updated: 3667303828716196400 - account: tug created: 7506229833280796000 description: this is a more detailed explanation of the resource. identifier: i name: resource name org: gum project: ln status: destroying updated: 3667303828716196400 - account: tug created: 7506229833280796000 description: this is a more detailed explanation of the resource. identifier: i name: resource name org: gum project: ln status: destroying updated: 3667303828716196400 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' post: tags: - Workspaces summary: Create workspace description: Create a new workspace. operationId: workspaces#create-workspace parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: vkb minLength: 1 maxLength: 128 example: ye - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: v8 minLength: 1 maxLength: 128 example: '3' - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: 81l minLength: 1 maxLength: 128 example: b requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateWorkspaceRequest' example: associated_template: template_id: b version: '4' budget: 0.039115082 ccm_cost_enabled: false cost_breakdown_json: c4a2d99bc28d236098a095277b7eb0718d6be068 cost_diff_json: c4a2d99bc28d236098a095277b7eb0718d6be068 cost_estimation_enabled: true default_pipelines: Est in.: project_pipeline: Et sunt nostrum voluptas nam. workspace_pipeline: Voluptatem aliquid sit rerum et qui autem. description: this is a more detailed explanation of the resource. environment_variables: Et voluptas reprehenderit commodi quo.: key: nd value: Aut excepturi soluta. value_type: secret Magni itaque labore non.: key: nd value: Aut excepturi soluta. value_type: secret Natus natus et.: key: nd value: Aut excepturi soluta. value_type: secret id: 639289500094086800 identifier: cp modules_json: c4a2d99bc28d236098a095277b7eb0718d6be068 name: resource name provider_connector: Nulla harum. provider_connectors: - connector_ref: b3 created: 1627590400 id: 7600418729279140000 terragrunt_provider: false type: vault updated: 1627686800 workspace_id: 7960420049770110000 - connector_ref: b3 created: 1627590400 id: 7600418729279140000 terragrunt_provider: false type: vault updated: 1627686800 workspace_id: 7960420049770110000 providers_json: c4a2d99bc28d236098a095277b7eb0718d6be068 provisioner: Illo mollitia pariatur molestiae. provisioner_configuration: Assumenda quibusdam ut libero rerum ratione maxime. provisioner_version: In minima adipisci alias fugiat eaque. prune_sensitive_data: true repository: Hic sequi et reiciendis. repository_branch: main repository_commit: abc10ed repository_connector: Corrupti doloribus consequatur tempore asperiores et. repository_path: '' repository_sha: abc10ed repository_submodules: recursive run_all: false sparse_checkout: Necessitatibus omnis. 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: Nesciunt asperiores iusto ea dolore id. repository_branch: main repository_commit: abc10ed repository_connector: Suscipit sed eligendi harum. repository_path: '' repository_sha: abc10ed - repository: Nesciunt asperiores iusto ea dolore id. repository_branch: main repository_commit: abc10ed repository_connector: Suscipit sed eligendi harum. repository_path: '' repository_sha: abc10ed terraform_variables: Deleniti veritatis.: key: nd value: Aut excepturi soluta. value_type: secret Nobis laudantium non incidunt iure voluptatem aut.: key: nd value: Aut excepturi soluta. value_type: secret Non voluptatem fugiat et quis.: key: nd value: Aut excepturi soluta. value_type: secret terragrunt_provider: true terragrunt_version: Et voluptate eum natus autem ratione. variable_sets: - Esse non. - Et et officia. responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/WorkspacesCreateWorkspaceResponseBody' example: 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 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyViolationError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{identifier}: delete: tags: - Workspaces summary: Destroy workspace description: Deletes the given workspace. operationId: workspaces#destroy-workspace parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: nlc minLength: 1 maxLength: 128 example: j - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: qn minLength: 1 maxLength: 128 example: '3' - name: identifier in: path description: Identifier is the project identifier. required: true schema: type: string description: Identifier is the project identifier. example: p minLength: 1 maxLength: 128 example: 9oo - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: v minLength: 1 maxLength: 128 example: t responses: '204': description: No Content response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' get: tags: - Workspaces summary: Show workspace description: Show an individual workspace. operationId: workspaces#show-workspace parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: x7 minLength: 1 maxLength: 128 example: '3' - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: '51' minLength: 1 maxLength: 128 example: wf - name: identifier in: path description: Identifier is the project identifier. required: true schema: type: string description: Identifier is the project identifier. example: a minLength: 1 maxLength: 128 example: m8c - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: g5g minLength: 1 maxLength: 128 example: 1a responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/WorkspacesShowWorkspaceResponseBody' example: account: l associated_template: template_id: u version: jkj backend_locked: true budget: 0.91501755 ccm_cost_enabled: false cost_breakdown_json: c4a2d99bc28d236098a095277b7eb0718d6be068 cost_diff_json: c4a2d99bc28d236098a095277b7eb0718d6be068 cost_estimation_enabled: true created: 9142952793299314000 default_pipelines: Doloremque exercitationem inventore est reiciendis.: project_pipeline: Quam vitae nulla. workspace_pipeline: Dolor velit quo eaque saepe. Rerum quo dolor et asperiores.: project_pipeline: Quam vitae nulla. workspace_pipeline: Dolor velit quo eaque saepe. description: this is a more detailed explanation of the resource. environment_variables: Dolores eum suscipit impedit fuga optio ut.: created: 6758585511865266000 key: tg updated: 2953533946315675600 value: Qui quod exercitationem et molestiae. value_type: string Unde dolorum aut autem mollitia nemo ipsam.: created: 6758585511865266000 key: tg updated: 2953533946315675600 value: Qui quod exercitationem et molestiae. value_type: string identifier: '0' lock: created_at: 5023311621798248000 id: Atque fuga. locked_by_display_name: Minima id rerum illo. locked_by_principal_id: Temporibus omnis culpa omnis debitis et et. locked_by_principal_type: Dolor quibusdam qui eos praesentium ea. manual: false reason: Doloribus laudantium nisi. modules_json: c4a2d99bc28d236098a095277b7eb0718d6be068 name: resource name org: t project: 1w provider_connector: Enim voluptatibus totam iusto. provider_connectors: - connector_ref: d7 created: 1627590400 id: 2574819312703867400 terragrunt_provider: true type: azure updated: 1627686800 workspace_id: 3425838825461482000 - connector_ref: d7 created: 1627590400 id: 2574819312703867400 terragrunt_provider: true type: azure updated: 1627686800 workspace_id: 3425838825461482000 - connector_ref: d7 created: 1627590400 id: 2574819312703867400 terragrunt_provider: true type: azure updated: 1627686800 workspace_id: 3425838825461482000 - connector_ref: d7 created: 1627590400 id: 2574819312703867400 terragrunt_provider: true type: azure updated: 1627686800 workspace_id: 3425838825461482000 providers_json: c4a2d99bc28d236098a095277b7eb0718d6be068 provisioner: Ea dicta veniam soluta. provisioner_configuration: Nulla deleniti. provisioner_data: Est est iusto. provisioner_version: Porro amet blanditiis libero eos alias. prune_sensitive_data: true repository: Ab consectetur beatae mollitia accusamus placeat molestiae. repository_branch: main repository_commit: abc10ed repository_connector: Nesciunt voluptatibus voluptatem. repository_path: '' repository_sha: abc10ed repository_submodules: recursive run_all: true sparse_checkout: Ex libero ipsum. state_checksum: d21c1662d8ce2c74f24efdc8db93eb34473b86810aeccca4b1518f70b0ccde8f status: provisioning tags: cost-center: engineering environment: production team: platform terraform_plan_json: f9e21473daaa2674d862b67a1339f4570e86de17 terraform_state: fc1200c7a7aa52109d762a9f005b149abef01479 terraform_state_json: c4a2d99bc28d236098a095277b7eb0718d6be068 terraform_variable_files: - repository: Rerum ipsam qui velit quo eius. repository_branch: main repository_commit: abc10ed repository_connector: Vel sed ea necessitatibus. repository_path: '' repository_sha: abc10ed - repository: Rerum ipsam qui velit quo eius. repository_branch: main repository_commit: abc10ed repository_connector: Vel sed ea necessitatibus. repository_path: '' repository_sha: abc10ed - repository: Rerum ipsam qui velit quo eius. repository_branch: main repository_commit: abc10ed repository_connector: Vel sed ea necessitatibus. repository_path: '' repository_sha: abc10ed terraform_variables: Id velit porro voluptatem.: created: 6758585511865266000 key: tg updated: 2953533946315675600 value: Qui quod exercitationem et molestiae. value_type: string Ratione dolorum qui culpa officia soluta.: created: 6758585511865266000 key: tg updated: 2953533946315675600 value: Qui quod exercitationem et molestiae. value_type: string Unde rerum neque dicta eius perferendis est.: created: 6758585511865266000 key: tg updated: 2953533946315675600 value: Qui quod exercitationem et molestiae. value_type: string terragrunt_provider: true terragrunt_version: Itaque iste est tempore nulla minima. updated: 8860729591363064000 variable_sets: - Nemo laudantium. - Similique repellat ratione beatae et ut. - Unde quia modi. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' put: tags: - Workspaces summary: Update workspace description: Updates the given workspace with new info. operationId: workspaces#update-workspace parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: gf minLength: 1 maxLength: 128 example: 7b9 - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: r minLength: 1 maxLength: 128 example: eo3 - name: identifier in: path description: Workspace identifier. required: true schema: type: string description: Workspace identifier. example: yl minLength: 1 maxLength: 128 example: g - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: f minLength: 1 maxLength: 128 example: gsc requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateWorkspaceRequest' example: budget: 0.27108407 ccm_cost_enabled: false cost_estimation_enabled: true default_pipelines: Omnis deserunt quo.: project_pipeline: Et sunt nostrum voluptas nam. workspace_pipeline: Voluptatem aliquid sit rerum et qui autem. Quam eos deserunt a aut.: project_pipeline: Et sunt nostrum voluptas nam. workspace_pipeline: Voluptatem aliquid sit rerum et qui autem. Velit officiis molestias minima.: project_pipeline: Et sunt nostrum voluptas nam. workspace_pipeline: Voluptatem aliquid sit rerum et qui autem. description: this is a more detailed explanation of the resource. environment_variables: Aut commodi velit.: key: nd value: Aut excepturi soluta. value_type: secret Id hic quia.: key: nd value: Aut excepturi soluta. value_type: secret Id laboriosam enim inventore corporis excepturi.: key: nd value: Aut excepturi soluta. value_type: secret name: resource name provider_connector: Consequatur harum aut dolores dicta voluptates. provider_connectors: - connector_ref: b3 created: 1627590400 id: 7600418729279140000 terragrunt_provider: false type: vault updated: 1627686800 workspace_id: 7960420049770110000 - connector_ref: b3 created: 1627590400 id: 7600418729279140000 terragrunt_provider: false type: vault updated: 1627686800 workspace_id: 7960420049770110000 provisioner: Enim numquam eum. provisioner_configuration: Atque debitis odit. provisioner_version: Id nostrum rerum tenetur soluta. prune_sensitive_data: true repository: Ipsa itaque fuga. repository_branch: main repository_commit: abc10ed repository_connector: Consequuntur iusto exercitationem itaque repellendus. repository_path: '' repository_sha: abc10ed repository_submodules: recursive run_all: true sparse_checkout: Reiciendis et ut ex aliquam pariatur. tags: cost-center: engineering environment: production team: platform terraform_variable_files: - repository: Nesciunt asperiores iusto ea dolore id. repository_branch: main repository_commit: abc10ed repository_connector: Suscipit sed eligendi harum. repository_path: '' repository_sha: abc10ed - repository: Nesciunt asperiores iusto ea dolore id. repository_branch: main repository_commit: abc10ed repository_connector: Suscipit sed eligendi harum. repository_path: '' repository_sha: abc10ed - repository: Nesciunt asperiores iusto ea dolore id. repository_branch: main repository_commit: abc10ed repository_connector: Suscipit sed eligendi harum. repository_path: '' repository_sha: abc10ed terraform_variables: Distinctio minus id.: key: nd value: Aut excepturi soluta. value_type: secret Eos voluptatem aut veniam autem et.: key: nd value: Aut excepturi soluta. value_type: secret Praesentium aut velit blanditiis.: key: nd value: Aut excepturi soluta. value_type: secret terragrunt_provider: false terragrunt_version: Sunt et minus voluptas recusandae sed qui. variable_sets: - Veniam sed aspernatur ut necessitatibus quae consectetur. - Voluptatem odit. - Rerum omnis vero rem rerum deleniti amet. - Consectetur iure architecto et. responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/UpdateWorkspaceResponse' example: 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 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyViolationError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{identifier}/actions/force-unlock: post: tags: - Workspaces summary: Unlock workspace description: Unlock a workspace, removing the lock regardless of its origin (manual or automatic). Idempotent. operationId: workspaces#force-unlock-workspace parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: zir minLength: 1 maxLength: 128 example: '80' - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: 8m minLength: 1 maxLength: 128 example: shz - name: identifier in: path description: Identifier is the project identifier. required: true schema: type: string description: Identifier is the project identifier. example: jb minLength: 1 maxLength: 128 example: cu - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: v minLength: 1 maxLength: 128 example: ki7 responses: '200': description: OK response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{identifier}/actions/lock: post: tags: - Workspaces summary: Lock workspace description: Create a manual lock on a workspace. operationId: workspaces#lock-workspace parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: 5b minLength: 1 maxLength: 128 example: v - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: 0ij minLength: 1 maxLength: 128 example: pr - name: identifier in: path description: Identifier is the project identifier. required: true schema: type: string description: Identifier is the project identifier. example: mj minLength: 1 maxLength: 128 example: s6 - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: 1gk minLength: 1 maxLength: 128 example: v requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/LockWorkspacePayload2' example: reason: Q2 freeze responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/LockWorkspaceResponse' example: id: a5ff0ef5-e8e9-4a64-a8bc-f1aa7c13b53e locked_by_display_name: Sapiente assumenda illo accusantium. locked_by_principal_id: Doloremque dolor similique. locked_by_principal_type: Quam necessitatibus veniam. manual: true reason: Suscipit aut. workspace: Tempore iure id. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{identifier}/modules: get: tags: - Workspaces summary: List modules description: List modules associated with this workspace. operationId: workspaces#list-workspace-modules parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: h4z minLength: 1 maxLength: 128 example: ank - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: 16x minLength: 1 maxLength: 128 example: 2h - name: identifier in: path description: Identifier is the project identifier. required: true schema: type: string description: Identifier is the project identifier. example: x2 minLength: 1 maxLength: 128 example: utl - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: vl minLength: 1 maxLength: 128 example: dnn responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/WorkspaceModuleCollection' example: - 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 - 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 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{identifier}/resources: get: tags: - Workspaces summary: List resources description: List resources associated with this workspace. operationId: workspaces#list-resources parameters: - name: limit in: query description: Limit is the number of records to return for a page. When omitted, all records are returned. allowEmptyValue: true schema: type: integer description: Limit is the number of records to return for a page. When omitted, all records are returned. example: 30 format: int64 minimum: 1 maximum: 1000 example: 30 - name: page in: query description: Page is the page number to return relative to the page 'limit'. When omitted, all records are returned. allowEmptyValue: true schema: type: integer description: Page is the page number to return relative to the page 'limit'. When omitted, all records are returned. example: 1 format: int64 minimum: 1 example: 1 - name: resource_types in: query description: Resource types to filter by. allowEmptyValue: true schema: type: array items: type: string example: Necessitatibus ut. description: Resource types to filter by. example: - aws_instance - google_compute_instance example: - aws_instance - google_compute_instance - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: n minLength: 1 maxLength: 128 example: fbm - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: u9 minLength: 1 maxLength: 128 example: tu - name: identifier in: path description: Workspace identifier. required: true schema: type: string description: Workspace identifier. example: mt minLength: 1 maxLength: 128 example: ix8 - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: b minLength: 1 maxLength: 128 example: zgy responses: '200': description: OK response. headers: x-page-size: description: Current page size (only populated for paginated list operations) schema: type: integer description: Current page size (only populated for paginated list operations) example: 50 format: int64 example: 50 x-total-items: description: Total items available (only populated for paginated list operations) schema: type: integer description: Total items available (only populated for paginated list operations) example: 1800 format: int64 example: 1800 x-total-pages: description: Total pages available (only populated for paginated list operations) schema: type: integer description: Total pages available (only populated for paginated list operations) example: 36 format: int64 example: 36 content: application/json: schema: $ref: '#/components/schemas/ListResourcesResponse' example: 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.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 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.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 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: Ipsam occaecati nihil id recusandae modi. - expression: <+outputs.instance_id> name: instance_public_ip sensitive: true stack_path: IaCM/TGOverride/environments/dev/ec2 value: Ipsam occaecati nihil id recusandae modi. - expression: <+outputs.instance_id> name: instance_public_ip sensitive: true stack_path: IaCM/TGOverride/environments/dev/ec2 value: Ipsam occaecati nihil id recusandae modi. 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.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 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.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 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 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{identifier}/resources/search: post: tags: - Workspaces summary: List resources using selectors description: '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.' operationId: workspaces#search-resources parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: lw minLength: 1 maxLength: 128 example: e - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: '1' minLength: 1 maxLength: 128 example: d - name: identifier in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: Voluptatem voluptatibus a quod. example: Laboriosam libero quo neque nesciunt quo alias. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: dx minLength: 1 maxLength: 128 example: '0' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SearchResourcesRequest' example: 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 responses: '200': description: OK response. headers: x-page-size: description: Current page size (only populated for paginated list operations) schema: type: integer description: Current page size (only populated for paginated list operations) example: 50 format: int64 example: 50 x-total-items: description: Total items available (only populated for paginated list operations) schema: type: integer description: Total items available (only populated for paginated list operations) example: 1800 format: int64 example: 1800 x-total-pages: description: Total pages available (only populated for paginated list operations) schema: type: integer description: Total pages available (only populated for paginated list operations) example: 36 format: int64 example: 36 content: application/json: schema: $ref: '#/components/schemas/SearchResourcesResponse' example: 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.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 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.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 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: Ipsam occaecati nihil id recusandae modi. - expression: <+outputs.instance_id> name: instance_public_ip sensitive: true stack_path: IaCM/TGOverride/environments/dev/ec2 value: Ipsam occaecati nihil id recusandae modi. - expression: <+outputs.instance_id> name: instance_public_ip sensitive: true stack_path: IaCM/TGOverride/environments/dev/ec2 value: Ipsam occaecati nihil id recusandae modi. 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.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 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.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 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 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/SearchResourcesResponse' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/clone: post: tags: - Workspaces summary: Clone workspace description: Clone the given workspace with new name. operationId: workspaces#clone-workspace parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: w8z minLength: 1 maxLength: 128 example: '1' - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: b6 minLength: 1 maxLength: 128 example: b - name: workspace in: path required: true schema: type: string example: Aliquam sit harum iste. example: Recusandae enim molestiae quaerat magni sed necessitatibus. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: c minLength: 1 maxLength: 128 example: fkq requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CloneWorkspaceRequest' example: identifier: '3' name: resource name responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/WorkspacesCreateWorkspaceResponseBody' example: 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 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/PolicyViolationError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/data: get: tags: - Workspaces summary: List data description: List all stored data for a workspace. operationId: workspaces#list-data parameters: - name: pipeline_execution_id in: query description: Filter by pipeline execution ID allowEmptyValue: true schema: type: string description: Filter by pipeline execution ID example: Sunt velit aut et explicabo. example: Dolores autem aut quos voluptas nisi voluptatem. - name: pipeline_stage_id in: query description: Filter by pipeline execution stage ID allowEmptyValue: true schema: type: string description: Filter by pipeline execution stage ID example: In pariatur consequatur ut at. example: Deleniti facilis facere. - name: provisioner_type in: query description: Filter by provisioner type allowEmptyValue: true schema: type: string description: Filter by provisioner type example: Omnis enim quos sint earum. example: Autem est necessitatibus quis omnis eos non. - name: data_type in: query description: Filter by data type allowEmptyValue: true schema: type: string description: Filter by data type example: Esse quia quos. example: Est sint quasi natus et. - name: stack_path in: query description: Filter by stack path allowEmptyValue: true schema: type: string description: Filter by stack path example: Rerum et enim eum et illo. example: Assumenda similique numquam magnam vel quasi nisi. - name: limit in: query description: Limit is the number of records to return for a page. allowEmptyValue: true schema: type: integer description: Limit is the number of records to return for a page. default: 30 example: 30 format: int64 minimum: 1 maximum: 1000 example: 30 - name: page in: query description: Page is the page number to return relative to the page 'limit'. allowEmptyValue: true schema: type: integer description: Page is the page number to return relative to the page 'limit'. default: 1 example: 1 format: int64 minimum: 1 example: 1 - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: 7c minLength: 1 maxLength: 128 example: 2y - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: h5 minLength: 1 maxLength: 128 example: l2j - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: Error rerum nisi qui quis esse sapiente. example: Atque omnis aperiam vitae dignissimos quo. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: b minLength: 1 maxLength: 128 example: wz4 responses: '200': description: OK response. headers: x-page-size: description: Current page size schema: type: integer description: Current page size example: 50 format: int64 example: 50 x-total-items: description: Total items available schema: type: integer description: Total items available example: 1800 format: int64 example: 1800 x-total-pages: description: Total pages available schema: type: integer description: Total pages available example: 36 format: int64 example: 36 content: application/json: schema: $ref: '#/components/schemas/WorkspaceDataResourceCollection' example: - account: sgp created: 3647044021827789000 data_type: cost_breakdown id: dc538c61-de48-4220-958c-5f3c4f983daa org: sf pipeline_execution_id: Laudantium cum aperiam corrupti quam. pipeline_id: Placeat et sed sed voluptate. pipeline_stage_id: Eligendi quasi in quis. project: '9' provisioner_type: tf rollback_source_id: Quisquam nesciunt sunt. stack_path: Sequi quia similique. stage_id: Quasi non modi consectetur reiciendis consequatur accusamus. workspace: workspace123 - account: sgp created: 3647044021827789000 data_type: cost_breakdown id: dc538c61-de48-4220-958c-5f3c4f983daa org: sf pipeline_execution_id: Laudantium cum aperiam corrupti quam. pipeline_id: Placeat et sed sed voluptate. pipeline_stage_id: Eligendi quasi in quis. project: '9' provisioner_type: tf rollback_source_id: Quisquam nesciunt sunt. stack_path: Sequi quia similique. stage_id: Quasi non modi consectetur reiciendis consequatur accusamus. workspace: workspace123 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' post: tags: - Workspaces summary: Create data description: Store binary data generated by the provisioner, such as plans and state files. operationId: workspaces#create-data parameters: - name: pipeline_id in: query description: The unique identifier for the associated pipeline allowEmptyValue: true required: true schema: type: string description: The unique identifier for the associated pipeline example: Deserunt similique id omnis doloribus. example: Sequi et sapiente perferendis non ea. - name: stage_id in: query description: The unique identifier for a stage allowEmptyValue: true required: true schema: type: string description: The unique identifier for a stage example: Quae blanditiis eveniet voluptates ducimus. example: Perferendis eos deserunt quaerat qui. - name: pipeline_execution_id in: query description: The unique identifier for the associated pipeline execution allowEmptyValue: true required: true schema: type: string description: The unique identifier for the associated pipeline execution example: Cupiditate inventore totam numquam. example: Voluptatum dolorem velit cupiditate magni dolor ea. - name: pipeline_stage_id in: query description: The unique identifier for the associated pipeline execution stage allowEmptyValue: true required: true schema: type: string description: The unique identifier for the associated pipeline execution stage example: Nulla quaerat. example: Nihil nihil veniam ut porro rerum mollitia. - name: provisioner_type in: query description: Type of provisioner that created the data allowEmptyValue: true required: true schema: type: string description: Type of provisioner that created the data example: tf enum: - tf - awscdk example: tf - name: data_type in: query description: Type of data stored allowEmptyValue: true required: true schema: type: string description: Type of data stored example: cost_breakdown enum: - plan_human - state_raw - state_human - cost_breakdown - cost_diff - modules - providers - cdk_template - cdk_manifest - cdk_tree - cdk_assets - cdk_diff - cdk_drift example: cdk_diff - name: policy_action in: query description: Policy action used during OPA evaluation allowEmptyValue: true schema: type: string description: Policy action used during OPA evaluation example: afterTerraformApply example: afterTerraformApply - name: opa_sdk_supported in: query description: Indicates the plugin supports OPA SDK-based evaluation allowEmptyValue: true schema: type: boolean description: Indicates the plugin supports OPA SDK-based evaluation example: true example: true - name: stack_path in: query description: Optional path to the stack module allowEmptyValue: true schema: type: string description: Optional path to the stack module example: Voluptates sunt. example: Labore occaecati at omnis placeat molestias. - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: b3 minLength: 1 maxLength: 128 example: ol - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: e minLength: 1 maxLength: 128 example: hu - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: workspace123 example: workspace123 - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: pa minLength: 1 maxLength: 128 example: ptb - name: Content-Length in: header description: Size in bytes of the data. allowEmptyValue: true schema: type: integer description: Size in bytes of the data. example: 3498299841947132000 format: int64 example: 7539159219830345000 responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/CreateDataResponse' example: id: dc538c61-de48-4220-958c-5f3c4f983daa policy_evaluation: - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. policy_evaluation_message: '- instance type ''xlarge'' is not permitted' policy_evaluation_status: error '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/data/{id}: get: tags: - Workspaces summary: Show data description: Get binary data generated by the provisioner, such as plans and state files. operationId: workspaces#show-data parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: pso minLength: 1 maxLength: 128 example: 1u - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: msy minLength: 1 maxLength: 128 example: k6v - name: workspace in: path description: Workspace is the resource workspace this variable is associated with. required: true schema: type: string description: Workspace is the resource workspace this variable is associated with. example: Libero sit. example: Vitae voluptatem quo perferendis. - name: id in: path description: The unique identifier for the data required: true schema: type: string description: The unique identifier for the data example: dc538c61-de48-4220-958c-5f3c4f983daa example: dc538c61-de48-4220-958c-5f3c4f983daa - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: 8q minLength: 1 maxLength: 128 example: hql responses: '200': description: OK response. content: application/json: schema: type: string format: binary '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/data/{id}/evaluate-policy: get: tags: - Workspaces summary: Evaluate data description: Evaluate policy against previously stored data, such as plans and state files. operationId: workspaces#evaluate-data parameters: - name: pipeline_execution_id in: query description: Pipeline execution associated with this evaluation allowEmptyValue: true schema: type: string description: Pipeline execution associated with this evaluation example: Quo doloribus facere et fugiat exercitationem. example: Consequatur enim iure animi adipisci. - name: policy_action in: query description: Policy action used during OPA evaluation allowEmptyValue: true required: true schema: type: string description: Policy action used during OPA evaluation example: afterTerraformApply example: afterTerraformApply - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: v5 minLength: 1 maxLength: 128 example: 1n9 - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: ocl minLength: 1 maxLength: 128 example: blk - name: workspace in: path description: Workspace is the resource workspace this variable is associated with. required: true schema: type: string description: Workspace is the resource workspace this variable is associated with. example: Est illum voluptas. example: Sint natus repellendus vel laboriosam at ipsa. - name: id in: path description: The unique identifier for the data required: true schema: type: string description: The unique identifier for the data example: dc538c61-de48-4220-958c-5f3c4f983daa example: dc538c61-de48-4220-958c-5f3c4f983daa - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: zcx minLength: 1 maxLength: 128 example: 5m responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/EvaluateDataResponse' example: id: dc538c61-de48-4220-958c-5f3c4f983daa policy_evaluation: - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. policy_evaluation_message: '- instance type ''xlarge'' is not permitted' policy_evaluation_status: error '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/dependency-graph: post: tags: - Workspaces summary: Upload dependency graph data description: Upload dependency graph for an existing plan file. operationId: workspaces#upload-dependency-graph parameters: - name: pipeline_id in: query description: The unique identifier for the associated pipeline allowEmptyValue: true required: true schema: type: string description: The unique identifier for the associated pipeline example: Atque autem recusandae non voluptas rerum amet. example: Rerum magni. - name: stage_id in: query description: The unique identifier for a stage allowEmptyValue: true required: true schema: type: string description: The unique identifier for a stage example: Perspiciatis dolores vel aut veritatis sed. example: Amet exercitationem ullam praesentium veniam. - name: pipeline_execution_id in: query description: The unique identifier for the associated pipeline execution allowEmptyValue: true required: true schema: type: string description: The unique identifier for the associated pipeline execution example: Perspiciatis nemo enim nam. example: Tenetur voluptatum et. - name: pipeline_stage_id in: query description: The unique identifier for the associated pipeline execution stage allowEmptyValue: true required: true schema: type: string description: The unique identifier for the associated pipeline execution stage example: Nobis quia ipsum autem. example: Aut consequatur unde ad iste. - name: provisioner_type in: query description: Type of provisioner that created the data allowEmptyValue: true required: true schema: type: string description: Type of provisioner that created the data example: awscdk enum: - tf - awscdk example: tf - name: data_type in: query description: Type of data stored allowEmptyValue: true required: true schema: type: string description: Type of data stored example: cost_diff enum: - plan_human - state_raw - state_human - cost_breakdown - cost_diff - modules - providers - cdk_template - cdk_manifest - cdk_tree - cdk_assets - cdk_diff - cdk_drift example: modules - name: stack_path in: query description: Optional path to the stack module allowEmptyValue: true schema: type: string description: Optional path to the stack module example: Odit molestias atque quia nemo nihil accusantium. example: Consequatur autem eveniet corrupti ab. - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: nk minLength: 1 maxLength: 128 example: e - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: v minLength: 1 maxLength: 128 example: 3e - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: workspace123 example: workspace123 - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: z minLength: 1 maxLength: 128 example: kx6 - name: Content-Length in: header description: Size in bytes of the graph data. allowEmptyValue: true schema: type: integer description: Size in bytes of the graph data. example: 8692366172134112000 format: int64 example: 8773926597975846000 responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/UploadDependencyGraphResponse' example: id: dc538c61-de48-4220-958c-5f3c4f983daa policy_evaluation: - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. policy_evaluation_message: '- instance type ''xlarge'' is not permitted' policy_evaluation_status: error '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/drift-config: delete: tags: - Workspaces summary: Disable drift automation for a workspace description: Removes drift scheduling and related configuration for the workspace. operationId: workspaces#delete-drift-config parameters: - name: provisioner in: query description: Provisioner key (defaults to opentofu when omitted) allowEmptyValue: true schema: type: string description: Provisioner key (defaults to opentofu when omitted) example: Enim nesciunt dolor aliquam ea voluptates deleniti. example: Consequuntur dolorem consectetur doloremque inventore omnis perspiciatis. - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: d minLength: 1 maxLength: 128 example: d - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: m minLength: 1 maxLength: 128 example: kx - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: Est nemo minima omnis sed eos et. example: Et voluptatum doloribus officiis. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: h5n minLength: 1 maxLength: 128 example: '2' responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/DeleteDriftConfigResponse' example: status: Harum cum molestiae repellat quo quisquam. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' get: tags: - Workspaces summary: Get drift automation status for a workspace description: Returns whether drift automation is enabled and related metadata. operationId: workspaces#get-drift-config parameters: - name: provisioner in: query description: Provisioner key (defaults to opentofu when omitted) allowEmptyValue: true schema: type: string description: Provisioner key (defaults to opentofu when omitted) example: Illum et facilis. example: Et qui modi. - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: zf9 minLength: 1 maxLength: 128 example: z - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: '7' minLength: 1 maxLength: 128 example: z - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: Id perspiciatis consequuntur soluta. example: Labore eos velit doloribus eum nulla laudantium. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: ou minLength: 1 maxLength: 128 example: mr responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/GetDriftConfigResponse' example: enabled: false pipeline_id: Inventore ad quo occaecati ratione aliquam. run_every: 8633270092580654000 run_every_unit: minutes trigger_id: Quidem est quia facilis maxime odit. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' put: tags: - Workspaces summary: Enable drift automation for a workspace description: Configures drift detection pipeline and schedule for the workspace. operationId: workspaces#update-drift-config parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: q minLength: 1 maxLength: 128 example: f - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: v7i minLength: 1 maxLength: 128 example: ec - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: Debitis iure architecto. example: Ipsum sed vel. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: hs4 minLength: 1 maxLength: 128 example: 1g1 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateDriftConfigRequest' example: pipeline_id: Reiciendis est dignissimos in magnam cum. provisioner: Numquam deleniti magni fugiat magni. run_every: 7662644581670084000 run_every_unit: minutes responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/UpdateDriftConfigResponse' example: status: Reprehenderit libero in. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/ephemeral-config: delete: tags: - Workspaces summary: Disable ephemeral TTL for a workspace description: Removes ephemeral scheduling and related configuration for the workspace. operationId: workspaces#delete-ephemeral-config parameters: - name: provisioner in: query description: Provisioner key (defaults to opentofu when omitted) allowEmptyValue: true schema: type: string description: Provisioner key (defaults to opentofu when omitted) example: Voluptas ipsam. example: Adipisci sequi et debitis. - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: zch minLength: 1 maxLength: 128 example: 1m - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: e2z minLength: 1 maxLength: 128 example: w15 - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: Excepturi dolorem ipsa. example: Optio explicabo eum eos asperiores ex. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: h minLength: 1 maxLength: 128 example: jlo responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/DeleteEphemeralConfigResponse' example: status: Ipsam suscipit impedit aliquam voluptate pariatur fugit. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' get: tags: - Workspaces summary: Get ephemeral TTL status for a workspace description: Returns whether ephemeral TTL is enabled and related metadata. operationId: workspaces#get-ephemeral-config parameters: - name: provisioner in: query description: Provisioner key (defaults to opentofu when omitted) allowEmptyValue: true schema: type: string description: Provisioner key (defaults to opentofu when omitted) example: Eligendi minus omnis. example: Nulla est sint impedit qui eos aut. - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: bsz minLength: 1 maxLength: 128 example: ok - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: r minLength: 1 maxLength: 128 example: mx3 - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: Odit autem odit ducimus voluptatem inventore. example: Dignissimos inventore reiciendis qui eaque. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: '38' minLength: 1 maxLength: 128 example: '12' responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/GetEphemeralConfigResponse' example: delete_at: Non magni impedit. delete_delay_unit: minutes delete_delay_value: 8909089752851921000 delete_on_date: Voluptate voluptas voluptas amet ut. delete_workspace: false destroy_at: Quae quis eum. destroy_on_date: Architecto atque cumque. enabled: true pipeline_id: Laborum provident consequuntur eum voluptas dolorem nisi. provisioner: Alias quidem quis nihil qui. source: disabled trigger_id: Sequi ut adipisci voluptatem. ttl_unit: seconds ttl_value: 7913793007029722000 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' put: tags: - Workspaces summary: Enable ephemeral TTL for a workspace description: Configures time-to-live settings to automatically destroy infrastructure and optionally delete the workspace. operationId: workspaces#update-ephemeral-config parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: '2' minLength: 1 maxLength: 128 example: h - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: a minLength: 1 maxLength: 128 example: 5t - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: Soluta cumque et dolores est repudiandae. example: Non ipsa praesentium voluptatem maiores. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: a minLength: 1 maxLength: 128 example: g requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateEphemeralConfigRequest' example: delete_delay_unit: hours delete_delay_value: 957687761797899600 delete_on_date: Natus et voluptas corporis dolor. delete_workspace: true destroy_delay_unit: days destroy_delay_value: 5926462219303765000 destroy_on_date: Dolore soluta maiores in necessitatibus vel. pipeline_id: Sit aspernatur eligendi repudiandae. provisioner: Id repellat dolorem. responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/UpdateEphemeralConfigResponse' example: delete_at: Error aut. destroy_at: Officia natus mollitia. status: Dolorem deleniti quos doloremque. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/events: post: tags: - Workspaces summary: Send event description: Store binary data generated by the provisioner, such as plans and state files. operationId: workspaces#send-event parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: '7' minLength: 1 maxLength: 128 example: 7x - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: b77 minLength: 1 maxLength: 128 example: ttq - name: workspace in: path description: Workspace associated with this event required: true schema: type: string description: Workspace associated with this event example: l minLength: 1 maxLength: 1024 example: k - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: ur minLength: 1 maxLength: 128 example: j5 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SendEventRequest' example: data: Aperiam dignissimos fuga qui.: Iusto odio exercitationem ipsa et dolorem. Maiores velit omnis dicta.: Corporis sit. Temporibus expedita vel iusto provident ducimus occaecati.: Est cupiditate quasi quia magnam facere tempore. event_type: plan metadata: PlannedChangesCount: 7183568001417402000 activity_status: incomplete activity_type: rollback cost_breakdown_uuid: Autem quia consequatur libero voluptas ipsa. cost_currency: Sapiente incidunt animi fuga. cost_diff_total_monthly: Doloremque accusantium officiis qui. cost_diff_uuid: Quod qui soluta tenetur odio quia cupiditate. cost_past_total_monthly: Ad placeat. cost_total_monthly: Earum culpa. cost_total_monthly_percentage_change: Modi corrupti expedita vel. data_length: 4979827047011853000 drift_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 enable_solutions_factory: true git_branch: Maiores ut et vel nihil. git_commit_message: Veritatis et aspernatur iste autem optio. git_commit_sha: Quaerat sint et est consequuntur veritatis. git_repo: Et iste assumenda. modules_uuid: Dolorem eius magni id sint quidem. output_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 pipeline: Est et aut quaerat commodi dolore numquam. pipeline_execution_id: Eos numquam est quia voluptate. pipeline_execution_number: Optio doloribus ut totam. pipeline_name: Ut nemo corrupti et. pipeline_stage_id: Expedita sit. plan_uuid: Soluta eos dolor qui. providers_uuid: Ad facilis reprehenderit cumque consequuntur voluptatem voluptatem. provisioner: Et quam commodi tenetur. provisioner_version: Quo aut voluptatem beatae nisi sapiente. resource_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 rollback_reason: Et odit blanditiis dignissimos qui. rollback_source_id: Doloremque consequatur et. stacks: - assets_uuid: Cumque et nesciunt. drift_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 drift_uuid: Maxime mollitia suscipit ea pariatur. error_message: Necessitatibus dolore. manifest_uuid: Saepe qui sit harum. resource_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 stack_name: A saepe molestiae eveniet sequi sed. stack_outputs: Alias cum magni sit eligendi.: Laboriosam cupiditate blanditiis ratione eos veritatis. Harum earum at.: Aut amet assumenda sint rem neque. Illo nesciunt dicta saepe iste omnis.: Qui eos facere iusto sed eos velit. stack_path: Exercitationem est consequuntur. status: success template_uuid: Quis quis. tree_uuid: Enim assumenda. - assets_uuid: Cumque et nesciunt. drift_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 drift_uuid: Maxime mollitia suscipit ea pariatur. error_message: Necessitatibus dolore. manifest_uuid: Saepe qui sit harum. resource_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 stack_name: A saepe molestiae eveniet sequi sed. stack_outputs: Alias cum magni sit eligendi.: Laboriosam cupiditate blanditiis ratione eos veritatis. Harum earum at.: Aut amet assumenda sint rem neque. Illo nesciunt dicta saepe iste omnis.: Qui eos facere iusto sed eos velit. stack_path: Exercitationem est consequuntur. status: success template_uuid: Quis quis. tree_uuid: Enim assumenda. state_checksum: Sit tenetur non quod iusto et dolorem. state_uuid: Accusantium possimus animi quis dolor et quia. terragrunt_details: - cost_breakdown_uuid: Odio sed nihil illum velit earum quo. cost_currency: Assumenda nesciunt laborum aperiam vero quibusdam. cost_diff_total_monthly: Architecto tempora. cost_diff_uuid: Non neque laborum. cost_past_total_monthly: Possimus expedita saepe. cost_total_monthly: Qui itaque. cost_total_monthly_percentage_change: Voluptas vel sapiente sunt magni est id. drift_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 output_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 path_id: Odit et nihil et fugiat. resource_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 state_file_link: Ullam officia rerum quia. status: Explicabo quod harum id qui sunt. - cost_breakdown_uuid: Odio sed nihil illum velit earum quo. cost_currency: Assumenda nesciunt laborum aperiam vero quibusdam. cost_diff_total_monthly: Architecto tempora. cost_diff_uuid: Non neque laborum. cost_past_total_monthly: Possimus expedita saepe. cost_total_monthly: Qui itaque. cost_total_monthly_percentage_change: Voluptas vel sapiente sunt magni est id. drift_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 output_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 path_id: Odit et nihil et fugiat. resource_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 state_file_link: Ullam officia rerum quia. status: Explicabo quod harum id qui sunt. - cost_breakdown_uuid: Odio sed nihil illum velit earum quo. cost_currency: Assumenda nesciunt laborum aperiam vero quibusdam. cost_diff_total_monthly: Architecto tempora. cost_diff_uuid: Non neque laborum. cost_past_total_monthly: Possimus expedita saepe. cost_total_monthly: Qui itaque. cost_total_monthly_percentage_change: Voluptas vel sapiente sunt magni est id. drift_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 output_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 path_id: Odit et nihil et fugiat. resource_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 state_file_link: Ullam officia rerum quia. status: Explicabo quod harum id qui sunt. - cost_breakdown_uuid: Odio sed nihil illum velit earum quo. cost_currency: Assumenda nesciunt laborum aperiam vero quibusdam. cost_diff_total_monthly: Architecto tempora. cost_diff_uuid: Non neque laborum. cost_past_total_monthly: Possimus expedita saepe. cost_total_monthly: Qui itaque. cost_total_monthly_percentage_change: Voluptas vel sapiente sunt magni est id. drift_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 output_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 path_id: Odit et nihil et fugiat. resource_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 state_file_link: Ullam officia rerum quia. status: Explicabo quod harum id qui sunt. trigger: Non cum iure.: A cum impedit et. Qui aut eaque.: Tempore mollitia et non. pipeline_execution_id: Quasi doloribus itaque est explicabo. pipeline_stage_id: Tempora sit. responses: '200': description: OK response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/pipelines: get: tags: - Workspaces summary: List pipelines description: List the pipelines where the workspace is been used operationId: workspaces#list-pipelines parameters: - name: limit in: query description: Limit is the number of records to return for a page. allowEmptyValue: true schema: type: integer description: Limit is the number of records to return for a page. default: 30 example: 30 format: int64 minimum: 1 maximum: 1000 example: 30 - name: page in: query description: Page is the page number to return relative to the page 'limit'. allowEmptyValue: true schema: type: integer description: Page is the page number to return relative to the page 'limit'. default: 1 example: 1 format: int64 minimum: 1 example: 1 - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: '0' minLength: 1 maxLength: 128 example: vot - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: j7 minLength: 1 maxLength: 128 example: x - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: Et numquam vero impedit tenetur placeat sapiente. example: Quidem voluptatem architecto. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: q minLength: 1 maxLength: 128 example: '1' responses: '200': description: OK response. headers: x-page-size: description: Current page size schema: type: integer description: Current page size example: 50 format: int64 example: 50 x-total-items: description: Total items available schema: type: integer description: Total items available example: 1800 format: int64 example: 1800 x-total-pages: description: Total pages available schema: type: integer description: Total pages available example: 36 format: int64 example: 36 content: application/json: schema: $ref: '#/components/schemas/ListPipelinesResponse' example: account: 2n org: '0' pipelines: - Est nemo necessitatibus mollitia eos dolorum ratione. - Non fuga maiores rem. project: yw0 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/remote-executions: post: tags: - Workspaces summary: Create remote execution description: Create a remote execution for a workspace. operationId: workspaces#create-remote-execution parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: sxt minLength: 1 maxLength: 128 example: du - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: ce1 minLength: 1 maxLength: 128 example: gy - name: workspace in: path description: The workspace associated with the remote execution. required: true schema: type: string description: The workspace associated with the remote execution. example: Libero eum ad ut. example: Voluptatem ea provident neque consectetur. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: cmj minLength: 1 maxLength: 128 example: t requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateRemoteExecutionRequest' example: custom_arguments: Aut nostrum aut modi est qui.: - Voluptas quia animi corporis corrupti laboriosam. - Facere commodi numquam itaque veritatis saepe magni. Sunt et rerum aut aut aliquam nobis.: - Voluptatum necessitatibus blanditiis. - Illum consequatur neque repellat quidem quia. - Omnis asperiores odit vero soluta labore. responses: '201': description: Created response. content: application/json: schema: $ref: '#/components/schemas/CreateRemoteExecutionResponse' example: account: rp created: 8925472830282933000 custom_arguments: Quaerat aliquam quo quia.: - Voluptatem aut. - Ullam sit reprehenderit enim minus commodi. - Qui vel iste assumenda porro. - Debitis deserunt atque. Saepe placeat minus.: - Modi dolorem fugiat animi maxime neque sint. - Sapiente illum. - Quo voluptatem quo voluptatibus maiores. executed: false id: a3859a1e-194d-4b56-8460-e2dab9442133 org: l pipeline_execution_id: Perspiciatis quis aperiam temporibus ut ipsum necessitatibus. pipeline_execution_url: Fugiat iste. project: egp sha256_checksum: Et porro blanditiis molestiae. updated: 8364298947036632000 workspace: Sit omnis distinctio ipsa assumenda voluptatum. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/remote-executions/{id}: get: tags: - Workspaces summary: Show remote execution description: Find remote execution operationId: workspaces#find-remote-execution parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: eds minLength: 1 maxLength: 128 example: a3 - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: ne1 minLength: 1 maxLength: 128 example: d - name: workspace in: path description: Workspace is the resource workspace this variable is associated with. required: true schema: type: string description: Workspace is the resource workspace this variable is associated with. example: Nulla aut est qui. example: Et nihil. - name: id in: path description: The ID of the remote execution required: true schema: type: string description: The ID of the remote execution example: 8cc47f61-b611-4d55-83ba-c7417ff96b2e format: uuid example: 3292f390-e81f-457b-87e6-bf2107ef5e55 - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: n minLength: 1 maxLength: 128 example: vc4 responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/ShowRemoteExecutionResponse' example: account: h39 created: 3967728839398149000 custom_arguments: Eos consectetur qui.: - Et voluptatem autem quaerat illo. - Quidem eos sapiente. - Et voluptate nam nihil sequi quam. - Dolores sunt. executed: false id: 0ddabf08-5b35-478b-bc51-795d0881fe0a org: r pipeline_execution_id: Et dicta consequatur nisi enim numquam. pipeline_execution_url: Autem natus dolores assumenda qui. project: jd sha256_checksum: Fugiat quibusdam soluta sint eius. updated: 3954206623322953700 workspace: Ex fuga minima provident. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/remote-executions/{id}/download: get: tags: - Workspaces summary: Download remote execution description: Download the source code for the remote plan. operationId: workspaces#download-remote-execution parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: 3j1 minLength: 1 maxLength: 128 example: 8s - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: a minLength: 1 maxLength: 128 example: bh0 - name: workspace in: path description: Workspace is the resource workspace this variable is associated with. required: true schema: type: string description: Workspace is the resource workspace this variable is associated with. example: Ipsa porro temporibus earum. example: Et velit harum ullam illum. - name: id in: path description: The ID of the remote execution required: true schema: type: string description: The ID of the remote execution example: 2e7ed6be-cbf9-4ade-9d83-9af252f5b65a format: uuid example: 8ccb8b67-8897-42d1-8b83-5f5712d91da4 - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: '75' minLength: 1 maxLength: 128 example: gt responses: '200': description: OK response. headers: Content-Digest: description: Content-Digest header as defined in https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Digest. Sha256 is the only supported algorithm. schema: type: string description: Content-Digest header as defined in https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Digest. Sha256 is the only supported algorithm. example: Eius et qui reprehenderit. example: Animi exercitationem est inventore veritatis nisi architecto. content: application/json: schema: type: string format: binary '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/remote-executions/{id}/execute: post: tags: - Workspaces summary: execute-remote-execution workspaces description: Execute the remote execution operationId: workspaces#execute-remote-execution parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: x3 minLength: 1 maxLength: 128 example: g5 - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: k minLength: 1 maxLength: 128 example: ryq - name: workspace in: path description: Workspace is the resource workspace this variable is associated with. required: true schema: type: string description: Workspace is the resource workspace this variable is associated with. example: Iure ratione commodi non eligendi rerum voluptas. example: Iusto quia quis veritatis itaque laborum. - name: id in: path description: The ID of the remote execution required: true schema: type: string description: The ID of the remote execution example: 98d9df20-a1a3-4cf5-8c9a-e4e1690aa258 format: uuid example: 32f4343b-ca19-4651-a4a1-08c476b221e2 - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: p minLength: 1 maxLength: 128 example: h responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/RemoteExecution' example: account: i created: 4451650124350750700 custom_arguments: Esse consequuntur.: - Earum ipsam. - Quo consequatur et quos aliquam. Molestiae aspernatur commodi occaecati veniam.: - Et est quia tempore temporibus. - Aliquam voluptatem quos est nostrum ut. - Sit exercitationem. - Qui enim. Voluptatem deserunt minima iusto molestias nemo.: - Dolor porro animi culpa sint. - Ab doloremque veniam omnis sit. - Dolores odio consequuntur incidunt. - Maiores eligendi qui. executed: true id: b30ef95d-f331-4550-b000-5560a0f9714e org: '3' pipeline_execution_id: Dicta error iure amet assumenda voluptas repudiandae. pipeline_execution_url: Temporibus facere doloribus sint non dolorem excepturi. project: og8 sha256_checksum: Mollitia non omnis vel accusantium voluptatem quisquam. updated: 6713465418713585000 workspace: Repellat rerum qui pariatur. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/remote-executions/{id}/upload: post: tags: - Workspaces summary: Upload remote execution source description: Upload the source code for the remote execution. operationId: workspaces#upload-remote-execution parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: o4 minLength: 1 maxLength: 128 example: gm - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: klq minLength: 1 maxLength: 128 example: '2' - name: workspace in: path description: Workspace is the resource workspace this variable is associated with. required: true schema: type: string description: Workspace is the resource workspace this variable is associated with. example: Nam est et architecto optio exercitationem. example: Et ut molestiae. - name: id in: path description: The ID of the remote execution required: true schema: type: string description: The ID of the remote execution example: d5c94778-9703-4d55-bbd9-9abc084a5653 format: uuid example: 0f6a8d51-5420-4ebc-9648-c2f9dcfcb0dd - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: 2z minLength: 1 maxLength: 128 example: '1' - name: Content-Length in: header description: Size in bytes of the source code. allowEmptyValue: true schema: type: integer description: Size in bytes of the source code. example: 7915008551940518000 format: int64 example: 8403877257311434000 - name: Content-Digest in: header description: Content-Digest header as defined in https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Digest. Sha256 is the only supported algorithm. allowEmptyValue: true required: true schema: type: string description: Content-Digest header as defined in https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Digest. Sha256 is the only supported algorithm. example: Sed doloribus aut quidem. example: Aut labore. responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/UploadRemoteExecutionResponse' example: account: n4 created: 6317977531171780000 custom_arguments: A quis.: - Soluta voluptatem distinctio voluptatem. - Dolorem voluptatibus veniam nihil. - Incidunt itaque aperiam deleniti. - Et impedit tempora consequatur quia necessitatibus nulla. Ratione magni doloremque et dignissimos dolore et.: - Ea et tempora quam sed veritatis. - Omnis voluptas voluptate sapiente culpa. Totam consequatur voluptas.: - Magni ipsum deserunt in. - Recusandae aspernatur eligendi odio soluta corporis adipisci. - Dolore voluptatem. - Velit laboriosam. executed: true id: 83d20295-ed6e-44ea-8c9b-a24a55798cdf org: axy pipeline_execution_id: Natus libero tempore dolorum natus. pipeline_execution_url: Corporis deleniti. project: xhv sha256_checksum: Rerum id et quas. updated: 5100012433285201000 workspace: Impedit excepturi eum. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/resource-types: get: tags: - Workspaces summary: List workspace resource types description: Retrieves the resource types used by workspaces operationId: workspaces#list-workspace-resource-types parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: 9dy minLength: 1 maxLength: 128 example: cxy - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: '2' minLength: 1 maxLength: 128 example: qs - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: Aspernatur et. example: Ipsa et ut odit doloremque sapiente et. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: w6 minLength: 1 maxLength: 128 example: l9 responses: '200': description: OK response. content: application/json: schema: type: array items: type: string example: Officia sit sint quia sit iusto perferendis. description: List of resource types example: - Quas blanditiis quo at. - Quo libero occaecati doloribus cumque. - Beatae cum ut velit voluptas error et. example: - Vitae consequatur. - Id aperiam. - Officiis molestias omnis laboriosam. - Similique quibusdam ipsum iusto explicabo. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/resource-types-and-attributes: get: tags: - Workspaces summary: Map of resource types and their attributes description: Retrieves the resource type attributes used by workspaces and attributes operationId: workspaces#list-workspace-resource-types-and-attributes parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: j8 minLength: 1 maxLength: 128 example: 1ly - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: o06 minLength: 1 maxLength: 128 example: d - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: Tenetur quam est ut. example: Ut adipisci veniam repellat quos. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: qx minLength: 1 maxLength: 128 example: al responses: '200': description: OK response. content: application/json: schema: type: object description: Map of resource types and their attributes example: Eum odit dolorem possimus.: - Laboriosam quod aut distinctio voluptatem adipisci tempora. - Autem molestias provident nesciunt sunt aut. - Quis deserunt et eaque tempore. Eum sint ipsa.: - Illum sequi. - Quis officiis nam reiciendis quasi vel. - Qui quibusdam omnis ut ab vel. - Doloremque nulla qui. Incidunt eos nemo laudantium.: - Sit inventore. - Dicta culpa rerum repellat quae placeat. additionalProperties: type: array items: type: string example: Quibusdam praesentium dolores velit. example: - Aut non aliquam vel saepe. - Enim sit distinctio perspiciatis laborum. - Dolore sed maxime. example: Non eligendi.: - Vero quis delectus ut libero. - Quia unde est at. - Aut sit exercitationem dolorem itaque quo. - Unde fugiat quam. Quo sed voluptas voluptatem.: - Officia in. - Sequi aut quasi commodi. Veniam repudiandae architecto consequatur sed facilis nisi.: - Sit magnam voluptas in blanditiis. - Velit sit. - Et dolor. - Eos qui expedita. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/resource-types/{resource_type}/attributes: get: tags: - Workspaces summary: List workspace resource type attributes description: Retrieves the resource type attributes used by workspaces operationId: workspaces#list-workspace-resource-type-attributes parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: '00' minLength: 1 maxLength: 128 example: c9 - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: de minLength: 1 maxLength: 128 example: p - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: Ipsa earum quae sed quia ab architecto. example: Rerum provident harum. - name: resource_type in: path description: Resource type required: true schema: type: string description: Resource type example: Unde laudantium voluptatem ea exercitationem qui ut. example: Fugiat eaque sapiente iste et. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: k minLength: 1 maxLength: 128 example: 5k responses: '200': description: OK response. content: application/json: schema: type: array items: type: string example: Officiis nam quam voluptatibus aut. description: List of resource type attributes example: - Assumenda est dolorem. - Est ut voluptatem est eius. example: - Ullam voluptatum commodi voluptas officiis hic. - Quis aliquid reiciendis autem est excepturi adipisci. - Dolor voluptatem odit in nostrum repellendus. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/resources: delete: tags: - Workspaces summary: Delete resources description: Deletes destroyed resources for a workspace. operationId: workspaces#delete-resources parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: '79' minLength: 1 maxLength: 128 example: 2d5 - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: zd minLength: 1 maxLength: 128 example: apg - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: Porro quo ut est. example: Architecto eveniet quia molestias voluptatem doloribus. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: v minLength: 1 maxLength: 128 example: lvu requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteResourcesRequest' example: resources: - module: Laboriosam iure excepturi quam. name: Dignissimos dolorum velit et porro pariatur. path_id: At quia harum exercitationem non. provider: Sint aut odit vel distinctio. type: Voluptatem deserunt ut veniam consequatur et facere. - module: Laboriosam iure excepturi quam. name: Dignissimos dolorum velit et porro pariatur. path_id: At quia harum exercitationem non. provider: Sint aut odit vel distinctio. type: Voluptatem deserunt ut veniam consequatur et facere. responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/DeleteResourcesResponse' example: results: - error: Sunt debitis alias incidunt architecto fugiat. module: Fugit labore dolor quo voluptas laboriosam. name: Non vero nesciunt ut eos ut iste. provider: Voluptatem quasi sequi sint hic sit libero. status: deleted type: Maiores aut omnis autem numquam incidunt nesciunt. - error: Sunt debitis alias incidunt architecto fugiat. module: Fugit labore dolor quo voluptas laboriosam. name: Non vero nesciunt ut eos ut iste. provider: Voluptatem quasi sequi sint hic sit libero. status: deleted type: Maiores aut omnis autem numquam incidunt nesciunt. - error: Sunt debitis alias incidunt architecto fugiat. module: Fugit labore dolor quo voluptas laboriosam. name: Non vero nesciunt ut eos ut iste. provider: Voluptatem quasi sequi sint hic sit libero. status: deleted type: Maiores aut omnis autem numquam incidunt nesciunt. summary: deleted: 3056372905831230500 failed: 1058023892543537200 skipped: 2913497782223108000 total: 8126230770775416000 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/DeleteResourcesResponse' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' patch: tags: - Workspaces summary: Update resources description: Updates resources for a workspace. operationId: workspaces#update-resources parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: k9r minLength: 1 maxLength: 128 example: m - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: d9s minLength: 1 maxLength: 128 example: fj - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: Rerum est consequuntur quia sit. example: Et minima dolores enim. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: hxi minLength: 1 maxLength: 128 example: i requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateResourcesRequest' example: resources: - attributes: Placeat et voluptatem dolorum molestias et rerum. drift_attributes: Nostrum aut sint vero.: Ratione placeat temporibus. drift_status: '' mode: Saepe molestiae aperiam. module: Cum dolorem qui aut delectus et. name: Eum qui et perspiciatis nihil voluptatibus. path_id: Quam assumenda a consequuntur harum ipsum officia. provider: Maxime sed. sensitive_attribute_paths: - Voluptatem eum neque debitis tenetur. - Ea harum eveniet rerum ipsa sunt. type: Fuga ut aut voluptatem facere quo veniam. - attributes: Placeat et voluptatem dolorum molestias et rerum. drift_attributes: Nostrum aut sint vero.: Ratione placeat temporibus. drift_status: '' mode: Saepe molestiae aperiam. module: Cum dolorem qui aut delectus et. name: Eum qui et perspiciatis nihil voluptatibus. path_id: Quam assumenda a consequuntur harum ipsum officia. provider: Maxime sed. sensitive_attribute_paths: - Voluptatem eum neque debitis tenetur. - Ea harum eveniet rerum ipsa sunt. type: Fuga ut aut voluptatem facere quo veniam. session_id: 4e93df4a-1aee-4cf9-a83e-aa74e4d807e2 update_mode: drift responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/UpdateResourcesResponse' example: results: - error: Quis quae ut atque et nemo. mode: Natus a error. module: Dicta omnis sint qui. name: Neque cumque esse dicta eos in. provider: Possimus sed illum illum dicta consequatur. status: skipped type: Consequatur quia quia et explicabo aut. - error: Quis quae ut atque et nemo. mode: Natus a error. module: Dicta omnis sint qui. name: Neque cumque esse dicta eos in. provider: Possimus sed illum illum dicta consequatur. status: skipped type: Consequatur quia quia et explicabo aut. - error: Quis quae ut atque et nemo. mode: Natus a error. module: Dicta omnis sint qui. name: Neque cumque esse dicta eos in. provider: Possimus sed illum illum dicta consequatur. status: skipped type: Consequatur quia quia et explicabo aut. summary: failed: 3209551945199997400 skipped: 5371041077206878000 total: 2670516380320101000 updated: 8521338423719211000 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/UpdateResourcesResponse' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/resources/stale: delete: tags: - Workspaces summary: Delete stale resources description: Deletes stale resources for a workspace that don't belong to the current session. operationId: workspaces#delete-stale-resources parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: x minLength: 1 maxLength: 128 example: r - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: '7' minLength: 1 maxLength: 128 example: hex - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: Maiores deleniti perferendis. example: Sunt cum explicabo eos qui quam consequatur. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: h minLength: 1 maxLength: 128 example: 6wy requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteStaleResourcesRequest' example: session_id: 9671ad1f-f89d-4b6e-acf3-135ade5cae22 responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/DeleteStaleResourcesResponse' example: deleted_count: 7006854695359918000 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/DeleteStaleResourcesResponse' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/risk-assessment: post: tags: - Workspaces summary: Upload risk assessment data description: Upload per-resource risk data and overall risk summary for an existing plan file. operationId: workspaces#upload-risk-assessment parameters: - name: pipeline_id in: query description: The unique identifier for the associated pipeline allowEmptyValue: true required: true schema: type: string description: The unique identifier for the associated pipeline example: Eum nihil sit sit. example: Delectus aut et corrupti vero tempora. - name: stage_id in: query description: The unique identifier for a stage allowEmptyValue: true required: true schema: type: string description: The unique identifier for a stage example: Eum et. example: Id praesentium adipisci ad. - name: pipeline_execution_id in: query description: The unique identifier for the associated pipeline execution allowEmptyValue: true required: true schema: type: string description: The unique identifier for the associated pipeline execution example: Est enim. example: Facere et ut ratione illum autem. - name: pipeline_stage_id in: query description: The unique identifier for the associated pipeline execution stage allowEmptyValue: true required: true schema: type: string description: The unique identifier for the associated pipeline execution stage example: Libero consequatur laborum sapiente et laboriosam. example: Adipisci dicta sit omnis nostrum quo quod. - name: provisioner_type in: query description: Type of provisioner that created the data allowEmptyValue: true required: true schema: type: string description: Type of provisioner that created the data example: awscdk enum: - tf - awscdk example: awscdk - name: data_type in: query description: Type of data stored allowEmptyValue: true required: true schema: type: string description: Type of data stored example: modules enum: - plan_human - state_raw - state_human - cost_breakdown - cost_diff - modules - providers - cdk_template - cdk_manifest - cdk_tree - cdk_assets - cdk_diff - cdk_drift example: state_human - name: stack_path in: query description: Optional path to the stack module allowEmptyValue: true schema: type: string description: Optional path to the stack module example: Voluptatem voluptas exercitationem adipisci quas rerum praesentium. example: Quia distinctio nobis. - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: u minLength: 1 maxLength: 128 example: '80' - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: esw minLength: 1 maxLength: 128 example: l - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: workspace123 example: workspace123 - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: '4' minLength: 1 maxLength: 128 example: ll - name: Content-Length in: header description: Size in bytes of the risk data. allowEmptyValue: true schema: type: integer description: Size in bytes of the risk data. example: 2259026685347259000 format: int64 example: 3371394724881327600 responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/UploadRiskAssessmentResponse' example: id: dc538c61-de48-4220-958c-5f3c4f983daa policy_evaluation: - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. policy_evaluation_message: '- instance type ''xlarge'' is not permitted' policy_evaluation_status: error '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/state-versions/{data_id}/rollback: post: tags: - Workspaces summary: Roll back workspace state to a previous version description: 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. operationId: workspaces#rollback-state parameters: - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: s minLength: 1 maxLength: 128 example: '91' - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: kp minLength: 1 maxLength: 128 example: n - name: workspace in: path description: Workspace identifier required: true schema: type: string description: Workspace identifier example: Enim eaque sint voluptate quo. example: In iste enim. - name: data_id in: path description: The unique identifier of the state version to roll back to required: true schema: type: string description: The unique identifier of the state version to roll back to example: 73dfd8ae-c6d1-4e5c-bf16-f773716260a5 format: uuid example: e926c50e-3e06-4d87-adc8-e67a095b91cf - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: a minLength: 1 maxLength: 128 example: c requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RollbackStateRequest' example: rollback_reason: Facere rerum laboriosam qui et. responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/RollbackStateResponse' example: activity_id: a434b34c-44ff-4719-ab16-32b0e90b8d15 new_data_id: 43f63ea0-a3ae-4025-a59d-b17baf4cf3a4 new_file_version: 3017602585939659000 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/orgs/{org}/projects/{project}/workspaces/provisioners-ratio: get: tags: - Workspaces summary: List provisioners ratio description: Retrieves the ratio of provisioners used by workspaces operationId: workspaces#list-provisioners-ratio parameters: - name: start_time in: query description: Start time filter (Unix timestamp) allowEmptyValue: true schema: type: integer description: Start time filter (Unix timestamp) example: 8013563813358098000 format: int64 example: 6705635906295202000 - name: end_time in: query description: End time filter (Unix timestamp) allowEmptyValue: true schema: type: integer description: End time filter (Unix timestamp) example: 5154886367248177000 format: int64 example: 8031480671987521000 - name: org in: path description: Org is the organisation identifier. required: true schema: type: string description: Org is the organisation identifier. example: h minLength: 1 maxLength: 128 example: d9 - name: project in: path description: Project is the project identifier. required: true schema: type: string description: Project is the project identifier. example: a minLength: 1 maxLength: 128 example: n - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: ac minLength: 1 maxLength: 128 example: 1h responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/ListProvisionersRatioResponse' example: provisioner: Dolor eos harum.: 0.07974645644321349 Iusto architecto quibusdam consequatur id sint.: 0.8459975667540844 total: 0.22165657980145306 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/workspace/templates/{template_id}: get: tags: - Workspaces summary: List workspaces associated with a template ID description: Get all workspaces associated with a specific template ID operationId: workspaces#list-associated-workspaces parameters: - name: org in: query description: Organization identifier (required for 'org' and 'project' scope). allowEmptyValue: true schema: type: string description: Organization identifier (required for 'org' and 'project' scope). example: x minLength: 1 maxLength: 128 example: usc - name: project in: query description: Project identifier (required for 'project' scope). allowEmptyValue: true schema: type: string description: Project identifier (required for 'project' scope). example: mpx minLength: 1 maxLength: 128 example: 7j - name: version in: query description: Template version associated with the workspace. allowEmptyValue: true schema: type: string description: Template version associated with the workspace. example: 6uq minLength: 1 maxLength: 32 example: '66' - name: template_id in: path description: Template identifier to filter workspaces required: true schema: type: string description: Template identifier to filter workspaces example: vas minLength: 1 maxLength: 128 example: nn - name: Harness-Account in: header description: Account identifier. allowEmptyValue: true required: true schema: type: string description: Account identifier. example: gv minLength: 1 maxLength: 128 example: k responses: '200': description: OK response. content: application/json: schema: type: array items: $ref: '#/components/schemas/HarnessIacmWorkspaceTemplate' description: List of workspaces associated with the template ID example: - account: o9n created_at: 1627590400 org: x96 project: 8jn template_id: w8 updated_at: 1627686800 version: de workspace_id: wx - account: o9n created_at: 1627590400 org: x96 project: 8jn template_id: w8 updated_at: 1627686800 version: de workspace_id: wx - account: o9n created_at: 1627590400 org: x96 project: 8jn template_id: w8 updated_at: 1627686800 version: de workspace_id: wx example: - account: o9n created_at: 1627590400 org: x96 project: 8jn template_id: w8 updated_at: 1627686800 version: de workspace_id: wx - account: o9n created_at: 1627590400 org: x96 project: 8jn template_id: w8 updated_at: 1627686800 version: de workspace_id: wx - account: o9n created_at: 1627590400 org: x96 project: 8jn template_id: w8 updated_at: 1627686800 version: de workspace_id: wx - account: o9n created_at: 1627590400 org: x96 project: 8jn template_id: w8 updated_at: 1627686800 version: de workspace_id: wx '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' components: schemas: LockWorkspaceResponse: type: object properties: id: type: string description: Lock ID example: 7188bce9-e7a7-453a-835f-f1e1ec2ca282 format: uuid locked_by_display_name: type: string description: Display name of who locked example: Maxime voluptate. locked_by_principal_id: type: string description: Principal ID who locked example: Nam repellat sit maiores aspernatur praesentium. locked_by_principal_type: type: string description: Type of principal example: Consequatur repellat qui mollitia quos numquam quas. manual: type: boolean description: Whether the lock is manual (user-initiated). true = manual lock, false = automatic lock example: false reason: type: string description: Reason for lock example: Maiores repellendus repellat repellat dolorem id provident. workspace: type: string description: Workspace identifier example: Porro reprehenderit ea laudantium. example: id: aed2792f-e130-473c-acea-068f906838b7 locked_by_display_name: Aut omnis dolorem similique aut. locked_by_principal_id: Sit rem. locked_by_principal_type: Commodi aliquam voluptas. manual: false reason: Sit sapiente qui. workspace: Fugiat modi non laboriosam ducimus vero impedit. required: - id - workspace - manual - reason - locked_by_principal_id - locked_by_principal_type - locked_by_display_name PolicyViolationError: type: object properties: fault: type: boolean description: Is the error a server-side fault? example: true id: type: string description: ID is a unique identifier for this particular occurrence of the problem. example: 123abc message: type: string description: Message is a human-readable explanation specific to this occurrence of the problem. example: parameter 'p' must be an integer name: type: string description: Name is the name of this class of errors. example: bad_request policy_evaluation: $ref: '#/components/schemas/IaCMEvaluation' temporary: type: boolean description: Is the error temporary? example: false timeout: type: boolean description: Is the error a timeout? example: true example: fault: false id: 123abc message: parameter 'p' must be an integer name: bad_request 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 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 temporary: false timeout: false required: - name - id - message - temporary - timeout - fault UpdateWorkspaceRequest: type: object properties: budget: type: number description: define the budget for a specific workspace example: 0.027989343 format: float ccm_cost_enabled: type: boolean description: define if CCM cost integration is enabled for this workspace default: false example: true cost_estimation_enabled: type: boolean description: define if cost estimation operations will be performed in this workspace default: false example: true default_pipelines: type: object description: List of default pipelines associated with this workspace and any per-workspace overrides. example: Omnis voluptatum facere voluptatem quia qui.: project_pipeline: Et sunt nostrum voluptas nam. workspace_pipeline: Voluptatem aliquid sit rerum et qui autem. additionalProperties: $ref: '#/components/schemas/DefaultPipelineOverride' description: type: string description: Description provides long-form text about the resource. example: this is a more detailed explanation of the resource. environment_variables: type: object description: list of environment variables configured on the workspace. example: Eos tempore natus dolor.: key: nd value: Aut excepturi soluta. value_type: secret Illum blanditiis qui nisi velit voluptatem id.: key: nd value: Aut excepturi soluta. value_type: secret Voluptatem assumenda commodi quasi ab quia.: key: nd value: Aut excepturi soluta. value_type: secret additionalProperties: $ref: '#/components/schemas/IaCMVariable' name: type: string description: Name is the human readable name for the resource. example: resource name minLength: 1 maxLength: 128 provider_connector: type: string description: Provider Connector is the reference to the connector for the infrastructure provider. example: Omnis ipsa. provider_connectors: type: array items: $ref: '#/components/schemas/WorkspaceProviderConnector' description: define an array of provider connectors that belong to Workspace example: - connector_ref: b3 created: 1627590400 id: 7600418729279140000 terragrunt_provider: false type: vault updated: 1627686800 workspace_id: 7960420049770110000 - connector_ref: b3 created: 1627590400 id: 7600418729279140000 terragrunt_provider: false type: vault updated: 1627686800 workspace_id: 7960420049770110000 provisioner: type: string description: Provisioner defines the provisioning tool to use. example: Quisquam qui consequatur magni. provisioner_configuration: type: string description: Provisioner configuration metadata (key value pair provisioner specific configuration). example: Eum consectetur saepe. provisioner_version: type: string description: Provisioner Version defines the tool version to use. default: latest example: Eum commodi qui necessitatibus occaecati necessitatibus. prune_sensitive_data: type: boolean description: prune_sensitive_data is a flag to enable or disable pruning of sensitive data default: false example: true repository: type: string description: Repository is the name of the repository to use. example: Quis magni alias quia. repository_branch: type: string description: Repository Branch in which the code should be accessed. example: main repository_commit: type: string description: Repository Commit/Tag in which the code should be accessed. example: abc10ed repository_connector: type: string description: Repository Connector is the reference to the connector to use for this code. example: Amet aut laudantium et quam ipsum. repository_path: type: string description: Repository Path is the path in which the infra code resides. default: '' example: '' repository_sha: type: string description: Repository SHA in which the code should be accessed. example: abc10ed repository_submodules: type: string description: repository_submodules is the instruction about whether to clone submodules in the pipeline step default: 'false' example: recursive enum: - 'false' - 'true' - recursive run_all: type: boolean description: Run-All terragrunt modules. example: false sparse_checkout: type: string description: List of patterens that will be used for sparse checkout option of git clone example: Dolor ut distinctio nobis. tags: type: object description: Tags associated with the workspace. example: cost-center: engineering environment: production team: platform additionalProperties: type: string example: Ducimus debitis ea et voluptas laborum. terraform_variable_files: type: array items: $ref: '#/components/schemas/WorkspaceTerraformVariableFiles' description: define an array of terraform variables files that belong to a different repository example: - repository: Nesciunt asperiores iusto ea dolore id. repository_branch: main repository_commit: abc10ed repository_connector: Suscipit sed eligendi harum. repository_path: '' repository_sha: abc10ed - repository: Nesciunt asperiores iusto ea dolore id. repository_branch: main repository_commit: abc10ed repository_connector: Suscipit sed eligendi harum. repository_path: '' repository_sha: abc10ed - repository: Nesciunt asperiores iusto ea dolore id. repository_branch: main repository_commit: abc10ed repository_connector: Suscipit sed eligendi harum. repository_path: '' repository_sha: abc10ed terraform_variables: type: object description: list of terraform variables configured on the workspace. example: Consectetur praesentium quis tempora eos.: key: nd value: Aut excepturi soluta. value_type: secret Ratione rem velit.: key: nd value: Aut excepturi soluta. value_type: secret additionalProperties: $ref: '#/components/schemas/IaCMVariable' terragrunt_provider: type: boolean description: Whether this workspace uses terragrunt to provision infrastructure default: false example: false terragrunt_version: type: string description: Terragrunt Version to use when provisioner is terragrunt. example: Voluptatum asperiores repellat at architecto cum. variable_sets: type: array items: type: string example: Sint animi id accusantium vel. description: Attached Variable Sets references example: - Quibusdam dolor nemo aut sint eaque. - Repudiandae architecto rerum ut accusamus ut. example: budget: 0.57549584 ccm_cost_enabled: false cost_estimation_enabled: true default_pipelines: Architecto quae consectetur voluptatem cumque doloremque.: project_pipeline: Et sunt nostrum voluptas nam. workspace_pipeline: Voluptatem aliquid sit rerum et qui autem. Qui sit dolor.: project_pipeline: Et sunt nostrum voluptas nam. workspace_pipeline: Voluptatem aliquid sit rerum et qui autem. Repudiandae inventore.: project_pipeline: Et sunt nostrum voluptas nam. workspace_pipeline: Voluptatem aliquid sit rerum et qui autem. description: this is a more detailed explanation of the resource. environment_variables: Illo impedit quae dolores exercitationem facilis.: key: nd value: Aut excepturi soluta. value_type: secret Natus omnis.: key: nd value: Aut excepturi soluta. value_type: secret name: resource name provider_connector: Eius rerum culpa consequatur et officia. provider_connectors: - connector_ref: b3 created: 1627590400 id: 7600418729279140000 terragrunt_provider: false type: vault updated: 1627686800 workspace_id: 7960420049770110000 - connector_ref: b3 created: 1627590400 id: 7600418729279140000 terragrunt_provider: false type: vault updated: 1627686800 workspace_id: 7960420049770110000 provisioner: Aut veritatis sit maxime odit. provisioner_configuration: Labore optio debitis. provisioner_version: Veniam officiis maiores. prune_sensitive_data: true repository: Animi exercitationem dignissimos sint adipisci. repository_branch: main repository_commit: abc10ed repository_connector: Reiciendis consequatur cupiditate iure. repository_path: '' repository_sha: abc10ed repository_submodules: recursive run_all: false sparse_checkout: Quibusdam labore dolor maxime. tags: cost-center: engineering environment: production team: platform terraform_variable_files: - repository: Nesciunt asperiores iusto ea dolore id. repository_branch: main repository_commit: abc10ed repository_connector: Suscipit sed eligendi harum. repository_path: '' repository_sha: abc10ed - repository: Nesciunt asperiores iusto ea dolore id. repository_branch: main repository_commit: abc10ed repository_connector: Suscipit sed eligendi harum. repository_path: '' repository_sha: abc10ed - repository: Nesciunt asperiores iusto ea dolore id. repository_branch: main repository_commit: abc10ed repository_connector: Suscipit sed eligendi harum. repository_path: '' repository_sha: abc10ed - repository: Nesciunt asperiores iusto ea dolore id. repository_branch: main repository_commit: abc10ed repository_connector: Suscipit sed eligendi harum. repository_path: '' repository_sha: abc10ed terraform_variables: Aut dolore explicabo iure optio inventore.: key: nd value: Aut excepturi soluta. value_type: secret Optio eligendi.: key: nd value: Aut excepturi soluta. value_type: secret Quia recusandae.: key: nd value: Aut excepturi soluta. value_type: secret terragrunt_provider: true terragrunt_version: Repudiandae omnis dolorem maiores eligendi. variable_sets: - Sapiente consequuntur impedit exercitationem voluptatem. - Nulla facere corrupti voluptatem ex. required: - terraform_variables - environment_variables - name - provider_connector - provisioner Stacks: type: object properties: assets_uuid: type: string description: UUID of the uploaded CDK assets for this stack example: Quo dolores non. drift_counts: $ref: '#/components/schemas/Counts' drift_uuid: type: string description: UUID of the uploaded drift detection results for this stack example: Aut ut eum ut maxime est. error_message: type: string description: Error message if status is failure example: Aut dolor. manifest_uuid: type: string description: UUID of the uploaded CDK manifest for this stack example: Molestias est corrupti sit. resource_counts: $ref: '#/components/schemas/Counts' stack_name: type: string description: Name of the CDK stack example: Iusto voluptas consequuntur. stack_outputs: type: object description: Outputs generated for stack example: Hic porro totam iusto alias.: Cumque eligendi quibusdam aperiam. Quibusdam delectus tenetur.: Ad nisi aut. Vitae eaque dolor et maxime.: Et quidem beatae aut tempora architecto omnis. additionalProperties: type: string example: Harum soluta molestias aperiam. stack_path: type: string description: Path to the stack within the CDK app example: Rerum autem labore maxime rerum. status: type: string description: Status of the stack operation example: failure enum: - success - failure - skipped template_uuid: type: string description: UUID of the uploaded CloudFormation template for this stack example: In rerum ea. tree_uuid: type: string description: UUID of the uploaded CDK tree for this stack example: Repudiandae omnis sapiente voluptatem libero exercitationem. description: Stack details for multi-stack deployments example: assets_uuid: Et pariatur. drift_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 drift_uuid: Ut velit et et facilis aperiam recusandae. error_message: Explicabo veritatis modi aspernatur officia quasi. manifest_uuid: Aut beatae tempore nesciunt praesentium aut explicabo. resource_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 stack_name: Minus qui. stack_outputs: Et vel.: Voluptas aut sit. Illo aperiam animi.: Sunt expedita quas facilis. Ratione tempore omnis est.: Corrupti necessitatibus. stack_path: Et necessitatibus vel est. status: skipped template_uuid: Quo aut pariatur qui non. tree_uuid: Ducimus adipisci praesentium omnis similique et corporis. ResourceUpdateSummary: type: object properties: failed: type: integer description: Number of resources that failed to update example: 6372429976734946000 format: int64 skipped: type: integer description: Number of resources skipped example: 4720481794457676000 format: int64 total: type: integer description: Total number of resources processed example: 7691417020444025000 format: int64 updated: type: integer description: Number of resources successfully updated example: 6501030956347305000 format: int64 description: Summary of a resource update operation example: failed: 7816136982411713000 skipped: 8507912447958775000 total: 8568780360306019000 updated: 3222795710095396000 required: - total - updated - skipped - failed RemoteExecution: type: object properties: account: type: string description: Account is the internal customer account ID. example: oi minLength: 1 maxLength: 128 created: type: integer description: Created is the unix timestamp at which the resource was originally created in milliseconds. example: 181328003400139230 format: int64 custom_arguments: type: object description: The arguments supplied to the plan. example: Explicabo eaque.: - Saepe accusamus beatae adipisci. - Omnis sit quae praesentium ea velit voluptas. - Harum aperiam. Voluptatum repellat quia.: - Sit placeat. - Omnis excepturi. - Nihil reprehenderit ut molestiae dolores itaque asperiores. additionalProperties: type: array items: type: string example: Et fugiat ut vel non necessitatibus. example: - Nostrum eaque quaerat qui asperiores. - Id mollitia harum repellat. - Itaque iusto dignissimos voluptates. executed: type: boolean description: The boolean value indicating if the remote execution has been executed. example: true id: type: string description: The ID of the remote execution. example: e4275760-4a0a-4681-9c7b-88e5d3e9c986 format: uuid org: type: string description: Org is the organisation identifier. example: g minLength: 1 maxLength: 128 pipeline_execution_id: type: string description: The pipeline execution ID of the pipeline executing the remote execution example: Occaecati tempora. pipeline_execution_url: type: string description: The pipeline execution URL of the pipeline executing the remote execution example: Deleniti quis iusto animi sequi. project: type: string description: Project is the project identifier. example: v minLength: 1 maxLength: 128 sha256_checksum: type: string description: The checksum of the patch file of changes that the remote execution will run against. example: Molestias dolor amet sunt. updated: type: integer description: Modified is the unix timestamp at which the resource was last modified in milliseconds. example: 1393363098868020700 format: int64 workspace: type: string description: The workspace associated with the remote execution. example: Quibusdam reprehenderit adipisci maiores quam et quos. description: remote execution details for a specific workspace. example: account: k9 created: 7606188415814059000 custom_arguments: Eaque enim quam similique.: - Sapiente quia quia aperiam laborum dolorem veritatis. - Atque libero quos aliquam maxime. Et ad nulla perferendis cum quaerat.: - Rem est. - Rerum in sit praesentium eligendi. - Minima qui iusto. executed: true id: 390d135f-8b48-4882-93c4-8ab96f8a8a1f org: y pipeline_execution_id: Sint voluptate id. pipeline_execution_url: Accusantium voluptatem qui vitae at nihil. project: u sha256_checksum: Et ex qui veniam. updated: 7038818124214267000 workspace: Cum ullam vitae. required: - account - org - project - id - workspace - pipeline_execution_id - pipeline_execution_url - created - updated - executed - sha256_checksum ResourceDelete: type: object properties: module: type: string description: Module path example: Reprehenderit cum voluptas minus quos rem. name: type: string description: Resource name example: Consectetur corrupti impedit est perferendis est. path_id: type: string description: Path id example: Doloremque assumenda molestiae qui sunt quo. provider: type: string description: Provider name example: Et aperiam quos quod et voluptate. type: type: string description: Resource type example: Consequatur nemo. description: Resource delete information example: module: Quia ad. name: Tempora quas pariatur ut et voluptatum. path_id: Provident aperiam quas. provider: At dicta harum suscipit dolores nisi explicabo. type: Repellat illo aliquid vero recusandae commodi omnis. required: - provider - type - name - module TerragruntDetail: type: object properties: cost_breakdown_uuid: type: string description: The ID of any associated cost breakdown data example: Alias enim veniam. cost_currency: type: string description: The currency used in cost data for this change example: Aut consequatur quis et aut quos. cost_diff_total_monthly: type: string description: The difference in total monthly cost example: Quia rerum consequuntur et. cost_diff_uuid: type: string description: The ID of any associated cost diff data example: Temporibus ut labore non voluptate incidunt. cost_past_total_monthly: type: string description: The past total monthly cost example: Consequuntur tenetur ut id omnis vel similique. cost_total_monthly: type: string description: The total monthly cost example: Eos assumenda. cost_total_monthly_percentage_change: type: string description: The percentage change in total monthly cost example: Nihil mollitia reiciendis odit autem culpa quibusdam. drift_counts: $ref: '#/components/schemas/Counts' output_counts: $ref: '#/components/schemas/Counts' path_id: type: string description: Path ID example: Molestiae suscipit vel et ut. resource_counts: $ref: '#/components/schemas/Counts' state_file_link: type: string description: State file link example: Est animi et molestiae optio voluptate. status: type: string description: Status example: In tempore ut debitis. example: cost_breakdown_uuid: Saepe vel consequatur et nisi enim. cost_currency: Cum dolorem porro quo distinctio. cost_diff_total_monthly: Minima sed aut omnis. cost_diff_uuid: Quis ut maxime. cost_past_total_monthly: Voluptatem enim. cost_total_monthly: Voluptatem aut nobis. cost_total_monthly_percentage_change: Ipsa ipsam nihil sunt et. drift_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 output_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 path_id: Ea consequuntur autem. resource_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 state_file_link: Impedit dolor adipisci fugit odio tempore eligendi. status: Voluptatem recusandae atque dolores cupiditate. CreateRemoteExecutionResponse: type: object properties: account: type: string description: Account is the internal customer account ID. example: ry minLength: 1 maxLength: 128 created: type: integer description: Created is the unix timestamp at which the resource was originally created in milliseconds. example: 9010740521014350000 format: int64 custom_arguments: type: object description: The arguments supplied to the plan. example: Et aut consequatur quo voluptatem atque.: - Quas perferendis quaerat ullam. - Sit excepturi et recusandae aut nihil. Et eligendi libero.: - Deserunt veniam et. - Sit sunt assumenda aut corporis occaecati. Ut magnam.: - Placeat corporis itaque explicabo sed autem fuga. - Eum vel odit quidem qui est. - Nihil maiores sed voluptates ab sit. additionalProperties: type: array items: type: string example: Omnis nihil porro blanditiis qui doloribus odit. example: - Nemo consectetur est molestiae sit. - Fugit sint incidunt ducimus eligendi ut tenetur. executed: type: boolean description: The boolean value indicating if the remote execution has been executed. example: true id: type: string description: The ID of the remote execution. example: 1bc60a7b-a21f-48f8-b4a1-d6a97f1b15ce format: uuid org: type: string description: Org is the organisation identifier. example: 9f minLength: 1 maxLength: 128 pipeline_execution_id: type: string description: The pipeline execution ID of the pipeline executing the remote execution example: Sit sequi placeat molestiae cumque. pipeline_execution_url: type: string description: The pipeline execution URL of the pipeline executing the remote execution example: Laboriosam accusamus impedit sint. project: type: string description: Project is the project identifier. example: rxy minLength: 1 maxLength: 128 sha256_checksum: type: string description: The checksum of the patch file of changes that the remote execution will run against. example: Ducimus rerum velit nemo sed dolor. updated: type: integer description: Modified is the unix timestamp at which the resource was last modified in milliseconds. example: 3634211334031111000 format: int64 workspace: type: string description: The workspace associated with the remote execution. example: Sunt autem accusantium. example: account: z created: 665040691179378700 custom_arguments: Quia ut ab inventore eos nihil perspiciatis.: - Optio voluptas voluptatum. - Libero occaecati ut et enim magni deserunt. Temporibus ad nisi quisquam.: - Facere eius voluptatum. - Est consequatur. - Laborum dolor eius et. executed: false id: 6a800783-d481-46eb-b166-9a3b706c8a31 org: u3u pipeline_execution_id: Voluptas iure adipisci pariatur. pipeline_execution_url: Harum quae. project: 1zx sha256_checksum: Sed et consequatur alias expedita sed voluptas. updated: 4251140389323478000 workspace: Earum velit nisi et optio assumenda. required: - account - org - project - id - workspace - pipeline_execution_id - pipeline_execution_url - created - updated - executed - sha256_checksum ListProvisionersRatioResponse: type: object properties: provisioner: type: object description: Provisioner name example: Iste ut adipisci fuga dolor.: 0.13509842909178746 Qui tempora non minima.: 0.6465705317881858 additionalProperties: type: number example: 0.7513672993239927 format: double total: type: number description: Total number of workspaces example: 0.20424530624102685 format: double description: List of provisioners ratio example: provisioner: Dolorum saepe illo eligendi culpa ea et.: 0.18779524533914582 Quis porro et temporibus.: 0.407837021231235 total: 0.3532713261946 required: - provisioner - total DeleteEphemeralConfigResponse: type: object properties: status: type: string description: Outcome message example: Rem quam laudantium. example: status: Voluptatem expedita architecto ea. required: - status HarnessIacmWorkspacedata: type: object properties: account: type: string description: Account is the internal customer account ID. example: sg minLength: 1 maxLength: 128 created: type: integer description: Created is the unix timestamp at which the resource was originally created in milliseconds. example: 7401290394048795000 format: int64 data_type: type: string description: Type of data stored example: cost_diff enum: - plan_human - state_raw - state_human - cost_breakdown - cost_diff - modules - providers - cdk_template - cdk_manifest - cdk_tree - cdk_assets - cdk_diff - cdk_drift id: type: string description: The unique identifier for the data example: dc538c61-de48-4220-958c-5f3c4f983daa org: type: string description: Org is the organisation identifier. example: 27l minLength: 1 maxLength: 128 pipeline_execution_id: type: string description: The unique identifier for the associated pipeline execution example: Mollitia dolor. pipeline_id: type: string description: The unique identifier for the associated pipeline example: Nostrum fugiat cum nostrum ut. pipeline_stage_id: type: string description: The unique identifier for the associated pipeline execution stage example: Aperiam consectetur et ut aperiam. project: type: string description: Project is the project identifier. example: 0l minLength: 1 maxLength: 128 provisioner_type: type: string description: Type of provisioner that created the data example: tf enum: - tf - awscdk rollback_source_id: type: string description: ID of the workspacedata row this entry was rolled back from; null for non-rollback entries example: Quos assumenda est tempora vero velit vero. stack_path: type: string description: Optional path to the stack module example: Aut dolorem et. stage_id: type: string description: The unique identifier for a stage example: Molestiae consequatur ipsam fuga. workspace: type: string description: Workspace identifier example: workspace123 description: WorkspaceDataResource is the representation for a single item of data associated with a workspace. example: account: '22' created: 5885848233292239000 data_type: cdk_manifest id: dc538c61-de48-4220-958c-5f3c4f983daa org: mh pipeline_execution_id: Fugiat facere aut corrupti voluptas animi quia. pipeline_id: Adipisci doloribus voluptatem nulla voluptatum necessitatibus. pipeline_stage_id: Explicabo eos enim odit expedita eum sequi. project: a9 provisioner_type: tf rollback_source_id: Dolorum reiciendis. stack_path: Molestiae et delectus ad nesciunt. stage_id: Dolorum qui excepturi aut ea. workspace: workspace123 required: - account - org - project - workspace - created - id - pipeline_id - stage_id - pipeline_execution_id - pipeline_stage_id - provisioner_type - data_type UpdateEphemeralConfigRequest: type: object properties: delete_delay_unit: type: string description: Unit for delete delay example: hours enum: - seconds - minutes - hours - days delete_delay_value: type: integer description: Delete workspace after N hours or days from now example: 1994662728079096600 format: int64 delete_on_date: type: string description: Specific date to delete workspace (ISO 8601 format, e.g. 2026-09-02) example: Enim tempora qui aut facilis et. delete_workspace: type: boolean description: Whether to delete the workspace record after infrastructure is destroyed example: true destroy_delay_unit: type: string description: Unit for destroy delay example: days enum: - seconds - minutes - hours - days destroy_delay_value: type: integer description: Destroy infrastructure after N hours or days from now example: 1536473475814728000 format: int64 destroy_on_date: type: string description: Specific date to destroy infrastructure (ISO 8601 format, e.g. 2026-08-24) example: Officia eum tempore est voluptatem fugit. pipeline_id: type: string description: Pipeline to run for destroying infrastructure example: Quae perferendis quo rerum. provisioner: type: string description: Provisioner key (defaults to opentofu when omitted) example: Veritatis id eveniet repudiandae sed totam. example: delete_delay_unit: days delete_delay_value: 4600655000822992000 delete_on_date: Sit voluptates pariatur. delete_workspace: true destroy_delay_unit: minutes destroy_delay_value: 37855449217063750 destroy_on_date: Amet labore itaque et cupiditate autem. pipeline_id: Ratione id accusantium cum aut. provisioner: Itaque pariatur officiis sint ducimus saepe. required: - pipeline_id RollbackStateRequest: type: object properties: rollback_reason: type: string description: Optional human-readable reason for the rollback example: Ea minus similique modi. example: rollback_reason: Ut aut. VariableResource: type: object properties: created: type: integer example: 1788278411761009200 format: int64 key: type: string description: Key is the identifier for the secret. example: z pattern: ^[a-zA-Z0-9_]+$ minLength: 1 maxLength: 128 updated: type: integer example: 5079273377921848000 format: int64 value: type: string description: Value is the value of the secret. example: Non blanditiis debitis minima iusto. value_type: type: string description: 'Type indecates the value type of the secret. In the case of secret this is a reference to an item in the secret store' example: secret enum: - string - secret description: Variable is the representation for a single variable associated with a workspace. example: created: 3228780114538247700 key: hk updated: 3888637973662049000 value: Nobis aliquam. value_type: secret required: - key - value - value_type - kind - created - updated DefaultPipelineOverride: type: object properties: project_pipeline: type: string description: Default pipeline assigned as the project-level example: Sunt earum ut voluptate non et. workspace_pipeline: type: string description: Default pipeline assigned as the workspace-level example: Deserunt aut assumenda. description: Per-workspace override to the assigned default pipelines. example: project_pipeline: Saepe non ut aspernatur eligendi. workspace_pipeline: Voluptate et non quidem. HarnessIacmWorkspaceTemplate: type: object properties: account: type: string description: Account identifier. example: 9ea minLength: 1 maxLength: 128 created_at: type: integer description: Timestamp when the workspace-template association was created. example: 1627590400 format: int64 org: type: string description: Organization identifier. example: lgs minLength: 1 maxLength: 128 project: type: string description: Project identifier. example: h1 minLength: 1 maxLength: 128 template_id: type: string description: Template identifier. example: fyc minLength: 1 maxLength: 128 updated_at: type: integer description: Timestamp when the workspace-template association was last updated. example: 1627686800 format: int64 version: type: string description: Template version associated with the workspace. example: n minLength: 1 maxLength: 32 workspace_id: type: string description: Workspace identifier. example: 4k minLength: 1 maxLength: 128 description: WorkspaceTemplateResource is the representation for a workspace-template association. example: account: '2' created_at: 1627590400 org: hg project: jql template_id: '3' updated_at: 1627686800 version: u workspace_id: '8' required: - workspace_id - template_id - created_at - updated_at - account - project - org UpdateWorkspaceResponse: type: object properties: policy_evaluation: $ref: '#/components/schemas/IaCMEvaluation' example: 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 WorkspaceDataResourceCollection: type: array items: $ref: '#/components/schemas/HarnessIacmWorkspacedata' example: - account: sgp created: 3647044021827789000 data_type: cost_breakdown id: dc538c61-de48-4220-958c-5f3c4f983daa org: sf pipeline_execution_id: Laudantium cum aperiam corrupti quam. pipeline_id: Placeat et sed sed voluptate. pipeline_stage_id: Eligendi quasi in quis. project: '9' provisioner_type: tf rollback_source_id: Quisquam nesciunt sunt. stack_path: Sequi quia similique. stage_id: Quasi non modi consectetur reiciendis consequatur accusamus. workspace: workspace123 - account: sgp created: 3647044021827789000 data_type: cost_breakdown id: dc538c61-de48-4220-958c-5f3c4f983daa org: sf pipeline_execution_id: Laudantium cum aperiam corrupti quam. pipeline_id: Placeat et sed sed voluptate. pipeline_stage_id: Eligendi quasi in quis. project: '9' provisioner_type: tf rollback_source_id: Quisquam nesciunt sunt. stack_path: Sequi quia similique. stage_id: Quasi non modi consectetur reiciendis consequatur accusamus. workspace: workspace123 - account: sgp created: 3647044021827789000 data_type: cost_breakdown id: dc538c61-de48-4220-958c-5f3c4f983daa org: sf pipeline_execution_id: Laudantium cum aperiam corrupti quam. pipeline_id: Placeat et sed sed voluptate. pipeline_stage_id: Eligendi quasi in quis. project: '9' provisioner_type: tf rollback_source_id: Quisquam nesciunt sunt. stack_path: Sequi quia similique. stage_id: Quasi non modi consectetur reiciendis consequatur accusamus. workspace: workspace123 - account: sgp created: 3647044021827789000 data_type: cost_breakdown id: dc538c61-de48-4220-958c-5f3c4f983daa org: sf pipeline_execution_id: Laudantium cum aperiam corrupti quam. pipeline_id: Placeat et sed sed voluptate. pipeline_stage_id: Eligendi quasi in quis. project: '9' provisioner_type: tf rollback_source_id: Quisquam nesciunt sunt. stack_path: Sequi quia similique. stage_id: Quasi non modi consectetur reiciendis consequatur accusamus. workspace: workspace123 HarnessIacmOutput: type: object properties: expression: type: string description: JEXL expression for dynamic output resolution example: <+outputs.instance_id> name: type: string description: Name associated with the output. example: instance_public_ip sensitive: type: boolean description: Indicates whether this value is sensitive example: true stack_path: type: string description: Stack path for Terragrunt workspaces example: IaCM/TGOverride/environments/dev/ec2 value: type: string description: Value associated with the output. example: Qui eum. description: Represents an individual output variable. example: expression: <+outputs.instance_id> name: instance_public_ip sensitive: true stack_path: IaCM/TGOverride/environments/dev/ec2 value: Omnis culpa et ex rerum eligendi. required: - name - value - sensitive IaCMEvaluationDetail: type: object properties: account_id: type: string description: Harness account ID associated with this policy set default: '' example: eBqAoNchMLKigC_qZ5EdC action: type: string description: Action that triggers the policy set example: onrun minLength: 1 created: type: integer description: Time the policy set was created example: 1636669297674 format: int64 description: type: string description: Description of the policy set example: Captures critical production policies details: type: array items: $ref: '#/components/schemas/IaCMEvaluatedPolicy' example: - deny_messages: - deployment stage 'example-stage' does not have a HarnessApproval step - deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}" policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: 'policy.rego:25: rego_parse_error: non-terminated string m == "test' status: error - deny_messages: - deployment stage 'example-stage' does not have a HarnessApproval step - deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}" policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: 'policy.rego:25: rego_parse_error: non-terminated string m == "test' status: error - deny_messages: - deployment stage 'example-stage' does not have a HarnessApproval step - deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}" policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: 'policy.rego:25: rego_parse_error: non-terminated string m == "test' status: error - 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: type: boolean description: Only enabled policy sets are evaluated when evaluating by type/action example: true identifier: type: string description: Identifier of the policy set example: policyset-1 minLength: 1 name: type: string description: Name of the policy set example: Production Policies minLength: 1 org_id: type: string description: Harness organization ID associated with this policy set default: '' example: test-org project_id: type: string description: Harness project ID associated with this policy set default: '' example: test-project status: type: string description: The overall status for this policy set indicating whether it passed example: error enum: - error - warning - pass type: type: string description: Type of input suitable for the policy set example: pipeline minLength: 1 updated: type: integer description: Time the policy set was last updated example: 1636669297674 format: int64 example: account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - deployment stage 'example-stage' does not have a HarnessApproval step - deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}" policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: 'policy.rego:25: rego_parse_error: non-terminated string m == "test' status: error - deny_messages: - deployment stage 'example-stage' does not have a HarnessApproval step - deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}" policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: 'policy.rego:25: rego_parse_error: non-terminated string m == "test' status: error - deny_messages: - deployment stage 'example-stage' does not have a HarnessApproval step - deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}" policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: 'policy.rego:25: rego_parse_error: non-terminated string m == "test' status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 required: - status - details - identifier - name - action - type - enabled - created - updated - account_id - org_id - project_id - entity_selector LockWorkspacePayload2: type: object properties: reason: type: string description: Reason for locking the workspace (optional) example: Q2 freeze maxLength: 1024 example: reason: Q2 freeze ResourcesSelector: type: object properties: include_conditions: type: array items: $ref: '#/components/schemas/ResourcesSelectorConditions' description: The conditions to include the resource. example: - attribute: tag.environment operator: equals value: prod path_id: type: string description: Path identifier to filter resources by example: qa provider: type: string description: Provider Type to filter resources by example: aws resource_type: type: string description: Type is the type of resource to select. example: aws_instance search_text: type: string description: Search resources by text string example: some text example: include_conditions: - attribute: tag.environment operator: equals value: prod path_id: qa provider: aws resource_type: aws_instance search_text: some text WorkspaceLock: type: object properties: created_at: type: integer description: Unix timestamp (milliseconds) when the lock was created. example: 2366466165031176000 format: int64 id: type: string description: Lock ID. example: Velit et. locked_by_display_name: type: string description: Display name of who locked the workspace. example: Consequatur voluptas natus ducimus quam aut quia. locked_by_principal_id: type: string description: Principal ID who locked the workspace. example: Necessitatibus voluptatem corrupti dolorem ipsa omnis. locked_by_principal_type: type: string description: Type of principal who locked the workspace. example: Earum optio. manual: type: boolean description: Whether the lock is manual (user-initiated). true = manual lock, false = automatic lock. example: true reason: type: string description: Reason for the lock. example: Porro doloremque voluptatem dolorem sed est voluptatem. description: workspaceLock holds the details of an active workspace lock. Fields are populated for manual (user-initiated) locks and left empty for automatic (Terraform CLI) locks. example: created_at: 7499313894044522000 id: Voluptas soluta. locked_by_display_name: Porro odit omnis quo. locked_by_principal_id: Aut doloremque et esse maxime eius at. locked_by_principal_type: Non voluptatem in ut. manual: false reason: Omnis laborum et deleniti. ResourceCollection: type: array items: $ref: '#/components/schemas/HarnessIacmResource' example: - 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.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 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.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 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.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 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.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 resource_id: arn:aws:s3:::my-bucket sensitive_attributes: - instance_type type: S3 Bucket RollbackStateResponse: type: object properties: activity_id: type: string description: The unique identifier of the audit activity record example: ad4d32ee-3186-428a-bfa5-4b85607b161d format: uuid new_data_id: type: string description: The unique identifier of the new state version created by the rollback example: d84a4cd1-0729-481c-860d-b5ba7a8ad607 format: uuid new_file_version: type: integer description: The file version timestamp (microseconds) of the new state object example: 1874192268079860700 format: int64 example: activity_id: 4fa941f5-9912-4d8b-b58e-1f41736a4e5a new_data_id: cda4b82a-ac88-4dfd-a79b-eef211075127 new_file_version: 7539318569312366000 required: - new_data_id - new_file_version - activity_id AssociatedTemplate: type: object properties: template_id: type: string description: Template ID of the template associated to the Workspace. example: '5' minLength: 1 maxLength: 128 version: type: string description: Version of the template associated to the Workspace. example: ers minLength: 1 maxLength: 64 description: AssociatedTemplate defines the template details with template_id and version. example: template_id: a4 version: 3j ActivityMetadata: type: object properties: PlannedChangesCount: type: integer description: 'Deprecated: use resource_count_xxxx fields instead' default: 0 example: 2570886191803212000 format: int64 activity_status: type: string description: The status of this activity example: incomplete enum: - success - failure - incomplete activity_type: type: string description: The type of this activity example: apply enum: - apply - destroy - plan - drifted - import - bootstrap - synth - deploy - diff - drift - rollback cost_breakdown_uuid: type: string description: The ID of any associated cost breakdown data example: Labore blanditiis sit. cost_currency: type: string description: The currency used in cost data for this change example: Quasi aut veritatis eos dicta quidem. cost_diff_total_monthly: type: string description: The currency used in cost data for this change example: Repellendus asperiores ut temporibus ea voluptas modi. cost_diff_uuid: type: string description: The ID of any associated cost diff data example: Eveniet itaque est quidem voluptatem architecto nobis. cost_past_total_monthly: type: string description: The currency used in cost data for this change example: Fuga ad placeat dicta ad et est. cost_total_monthly: type: string description: The currency used in cost data for this change example: Amet voluptas est porro sit et. cost_total_monthly_percentage_change: type: string description: The currency used in cost data for this change example: Adipisci praesentium expedita magnam facilis voluptas impedit. data_length: type: integer description: The length of the data default: 0 example: 7972182802535945000 format: int64 drift_counts: $ref: '#/components/schemas/Counts' enable_solutions_factory: type: boolean description: Indicates if Harness Solution Factory functionality is enabled example: true git_branch: type: string description: Git branch associated with this execution example: Nam voluptates eos voluptatem maiores. git_commit_message: type: string description: Git commit message associated with this execution example: Non et magnam expedita. git_commit_sha: type: string description: Git commit SHA associated with this execution example: Itaque quo quas. git_repo: type: string description: Git repo associated with this execution example: Aut natus molestias fuga excepturi. modules_uuid: type: string description: The ID of any associated modules data example: Consequuntur veniam culpa laudantium autem blanditiis. output_counts: $ref: '#/components/schemas/Counts' pipeline: type: string description: The unique identifier of any associated pipeline example: Non illum exercitationem et sunt earum. pipeline_execution_id: type: string description: The unique identifier for any associated pipeline execution example: Accusantium et voluptas. pipeline_execution_number: type: string description: The unique number for any associated pipeline execution example: Reiciendis consequatur culpa voluptate a nulla. pipeline_name: type: string description: The name of any associated pipeline example: Labore repellat cumque sapiente molestias voluptates. pipeline_stage_id: type: string description: The unique identifier for the associated pipeline stage example: Qui commodi. plan_uuid: type: string description: The ID of any associated plan data example: Non quo et. providers_uuid: type: string description: The ID of any associated providers data example: Reiciendis nemo sunt quis. provisioner: type: string description: The provisioner in use example: Incidunt omnis consequatur expedita necessitatibus. provisioner_version: type: string description: The current version of the provisioner in use example: Ut maxime velit et qui delectus. resource_counts: $ref: '#/components/schemas/Counts' rollback_reason: type: string description: 'For rollback activities: optional human-readable reason provided by the actor' example: Aliquid ad qui est ut fuga. rollback_source_id: type: string description: 'For rollback activities: the workspacedata ID that was rolled back from' example: Officia voluptatem qui. stacks: type: array items: $ref: '#/components/schemas/Stacks' description: Stack details for multi-stack deployments example: - assets_uuid: Et consequuntur rerum rerum fugiat voluptatem. drift_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 drift_uuid: Eligendi assumenda placeat vero dolorem quia sint. error_message: Et sit quis dolores dolores. manifest_uuid: Laboriosam labore illo magnam quae officia. resource_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 stack_name: Recusandae amet cupiditate recusandae libero. stack_outputs: Eum alias ex molestiae adipisci odio ut.: Tempore molestias sit asperiores sunt debitis. stack_path: Reiciendis error inventore saepe animi. status: failure template_uuid: Et enim dolores earum tempore totam porro. tree_uuid: Ducimus sed sed enim. - assets_uuid: Et consequuntur rerum rerum fugiat voluptatem. drift_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 drift_uuid: Eligendi assumenda placeat vero dolorem quia sint. error_message: Et sit quis dolores dolores. manifest_uuid: Laboriosam labore illo magnam quae officia. resource_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 stack_name: Recusandae amet cupiditate recusandae libero. stack_outputs: Eum alias ex molestiae adipisci odio ut.: Tempore molestias sit asperiores sunt debitis. stack_path: Reiciendis error inventore saepe animi. status: failure template_uuid: Et enim dolores earum tempore totam porro. tree_uuid: Ducimus sed sed enim. - assets_uuid: Et consequuntur rerum rerum fugiat voluptatem. drift_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 drift_uuid: Eligendi assumenda placeat vero dolorem quia sint. error_message: Et sit quis dolores dolores. manifest_uuid: Laboriosam labore illo magnam quae officia. resource_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 stack_name: Recusandae amet cupiditate recusandae libero. stack_outputs: Eum alias ex molestiae adipisci odio ut.: Tempore molestias sit asperiores sunt debitis. stack_path: Reiciendis error inventore saepe animi. status: failure template_uuid: Et enim dolores earum tempore totam porro. tree_uuid: Ducimus sed sed enim. state_checksum: type: string description: The checksum of the last-seen state file example: Est vel. state_uuid: type: string description: The ID of any associated state data example: Est distinctio adipisci quam id. terragrunt_details: type: array items: $ref: '#/components/schemas/TerragruntDetail' description: Terragrunt details for any associated execution example: - cost_breakdown_uuid: Labore aliquam qui est. cost_currency: Facere perferendis ab sunt. cost_diff_total_monthly: Ullam quasi distinctio nostrum ducimus. cost_diff_uuid: Repudiandae sunt ut cum voluptatem. cost_past_total_monthly: Voluptas amet et. cost_total_monthly: Aut temporibus et aperiam dignissimos tenetur. cost_total_monthly_percentage_change: Id temporibus enim. drift_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 output_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 path_id: Alias nihil sed voluptate hic. resource_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 state_file_link: Natus eum recusandae fugit officiis delectus omnis. status: Omnis et maxime sunt. - cost_breakdown_uuid: Labore aliquam qui est. cost_currency: Facere perferendis ab sunt. cost_diff_total_monthly: Ullam quasi distinctio nostrum ducimus. cost_diff_uuid: Repudiandae sunt ut cum voluptatem. cost_past_total_monthly: Voluptas amet et. cost_total_monthly: Aut temporibus et aperiam dignissimos tenetur. cost_total_monthly_percentage_change: Id temporibus enim. drift_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 output_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 path_id: Alias nihil sed voluptate hic. resource_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 state_file_link: Natus eum recusandae fugit officiis delectus omnis. status: Omnis et maxime sunt. - cost_breakdown_uuid: Labore aliquam qui est. cost_currency: Facere perferendis ab sunt. cost_diff_total_monthly: Ullam quasi distinctio nostrum ducimus. cost_diff_uuid: Repudiandae sunt ut cum voluptatem. cost_past_total_monthly: Voluptas amet et. cost_total_monthly: Aut temporibus et aperiam dignissimos tenetur. cost_total_monthly_percentage_change: Id temporibus enim. drift_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 output_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 path_id: Alias nihil sed voluptate hic. resource_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 state_file_link: Natus eum recusandae fugit officiis delectus omnis. status: Omnis et maxime sunt. trigger: type: object description: Trigger info for any associated pipeline execution example: Nemo quibusdam voluptatem veniam ut quas.: Eum sapiente. Vel qui veniam.: Ipsa ipsum corrupti delectus sunt eveniet autem. additionalProperties: true example: PlannedChangesCount: 6562707041593284000 activity_status: incomplete activity_type: synth cost_breakdown_uuid: Ipsa nemo expedita officiis. cost_currency: Est ipsum aut nisi voluptatem voluptatum voluptas. cost_diff_total_monthly: Et dolor omnis ad. cost_diff_uuid: Architecto laborum esse. cost_past_total_monthly: Voluptates explicabo voluptas qui quibusdam. cost_total_monthly: Pariatur animi dolorum asperiores deserunt et. cost_total_monthly_percentage_change: Eum reiciendis. data_length: 9080201327928640000 drift_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 enable_solutions_factory: true git_branch: Hic velit. git_commit_message: Ut aut ut reprehenderit et. git_commit_sha: Vel eligendi debitis perspiciatis. git_repo: Provident qui cumque repellendus natus ut repellendus. modules_uuid: Voluptatem sit ea et voluptate. output_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 pipeline: Voluptatem quam a et eveniet. pipeline_execution_id: Vitae sed ea aut dicta praesentium ex. pipeline_execution_number: Adipisci minima eum optio hic ab. pipeline_name: Iure maxime vero amet repellat. pipeline_stage_id: Repellendus accusamus soluta nobis. plan_uuid: Sit sed consectetur temporibus tempora. providers_uuid: Veritatis debitis exercitationem libero eum sint. provisioner: Nisi quam. provisioner_version: Eos et. resource_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 rollback_reason: Iste consequatur ut dolores quia ipsa. rollback_source_id: Et aliquid ducimus. stacks: - assets_uuid: Et consequuntur rerum rerum fugiat voluptatem. drift_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 drift_uuid: Eligendi assumenda placeat vero dolorem quia sint. error_message: Et sit quis dolores dolores. manifest_uuid: Laboriosam labore illo magnam quae officia. resource_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 stack_name: Recusandae amet cupiditate recusandae libero. stack_outputs: Eum alias ex molestiae adipisci odio ut.: Tempore molestias sit asperiores sunt debitis. stack_path: Reiciendis error inventore saepe animi. status: failure template_uuid: Et enim dolores earum tempore totam porro. tree_uuid: Ducimus sed sed enim. - assets_uuid: Et consequuntur rerum rerum fugiat voluptatem. drift_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 drift_uuid: Eligendi assumenda placeat vero dolorem quia sint. error_message: Et sit quis dolores dolores. manifest_uuid: Laboriosam labore illo magnam quae officia. resource_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 stack_name: Recusandae amet cupiditate recusandae libero. stack_outputs: Eum alias ex molestiae adipisci odio ut.: Tempore molestias sit asperiores sunt debitis. stack_path: Reiciendis error inventore saepe animi. status: failure template_uuid: Et enim dolores earum tempore totam porro. tree_uuid: Ducimus sed sed enim. - assets_uuid: Et consequuntur rerum rerum fugiat voluptatem. drift_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 drift_uuid: Eligendi assumenda placeat vero dolorem quia sint. error_message: Et sit quis dolores dolores. manifest_uuid: Laboriosam labore illo magnam quae officia. resource_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 stack_name: Recusandae amet cupiditate recusandae libero. stack_outputs: Eum alias ex molestiae adipisci odio ut.: Tempore molestias sit asperiores sunt debitis. stack_path: Reiciendis error inventore saepe animi. status: failure template_uuid: Et enim dolores earum tempore totam porro. tree_uuid: Ducimus sed sed enim. state_checksum: Quo aut ut aut aperiam laboriosam consequatur. state_uuid: Et et et soluta. terragrunt_details: - cost_breakdown_uuid: Labore aliquam qui est. cost_currency: Facere perferendis ab sunt. cost_diff_total_monthly: Ullam quasi distinctio nostrum ducimus. cost_diff_uuid: Repudiandae sunt ut cum voluptatem. cost_past_total_monthly: Voluptas amet et. cost_total_monthly: Aut temporibus et aperiam dignissimos tenetur. cost_total_monthly_percentage_change: Id temporibus enim. drift_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 output_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 path_id: Alias nihil sed voluptate hic. resource_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 state_file_link: Natus eum recusandae fugit officiis delectus omnis. status: Omnis et maxime sunt. - cost_breakdown_uuid: Labore aliquam qui est. cost_currency: Facere perferendis ab sunt. cost_diff_total_monthly: Ullam quasi distinctio nostrum ducimus. cost_diff_uuid: Repudiandae sunt ut cum voluptatem. cost_past_total_monthly: Voluptas amet et. cost_total_monthly: Aut temporibus et aperiam dignissimos tenetur. cost_total_monthly_percentage_change: Id temporibus enim. drift_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 output_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 path_id: Alias nihil sed voluptate hic. resource_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 state_file_link: Natus eum recusandae fugit officiis delectus omnis. status: Omnis et maxime sunt. - cost_breakdown_uuid: Labore aliquam qui est. cost_currency: Facere perferendis ab sunt. cost_diff_total_monthly: Ullam quasi distinctio nostrum ducimus. cost_diff_uuid: Repudiandae sunt ut cum voluptatem. cost_past_total_monthly: Voluptas amet et. cost_total_monthly: Aut temporibus et aperiam dignissimos tenetur. cost_total_monthly_percentage_change: Id temporibus enim. drift_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 output_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 path_id: Alias nihil sed voluptate hic. resource_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 state_file_link: Natus eum recusandae fugit officiis delectus omnis. status: Omnis et maxime sunt. - cost_breakdown_uuid: Labore aliquam qui est. cost_currency: Facere perferendis ab sunt. cost_diff_total_monthly: Ullam quasi distinctio nostrum ducimus. cost_diff_uuid: Repudiandae sunt ut cum voluptatem. cost_past_total_monthly: Voluptas amet et. cost_total_monthly: Aut temporibus et aperiam dignissimos tenetur. cost_total_monthly_percentage_change: Id temporibus enim. drift_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 output_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 path_id: Alias nihil sed voluptate hic. resource_counts: added: 4302650415427610600 changed: 4854591900953545000 deleted: 1274854759779507500 imported: 4979352803105197000 removed: 8385348900669245000 unchanged: 5543766798044174000 state_file_link: Natus eum recusandae fugit officiis delectus omnis. status: Omnis et maxime sunt. trigger: Rerum et.: Vel libero voluptas ullam ut alias. UploadDependencyGraphResponse: type: object properties: id: type: string description: The unique identifier for the data example: dc538c61-de48-4220-958c-5f3c4f983daa policy_evaluation: type: array items: $ref: '#/components/schemas/WorkspaceDataPolicyEvaluation' description: Individual policy evaluation details example: - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. policy_evaluation_message: type: string description: Pre-rendered message included when policy evaluation did not pass example: '- instance type ''xlarge'' is not permitted' policy_evaluation_status: type: string description: The overall status of policy evaluation (if it occurred) indicating whether it passed example: error enum: - error - warning - pass example: id: dc538c61-de48-4220-958c-5f3c4f983daa policy_evaluation: - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. policy_evaluation_message: '- instance type ''xlarge'' is not permitted' policy_evaluation_status: error required: - id DeleteStaleResourcesResponse: type: object properties: deleted_count: type: integer description: Number of stale resources deleted example: 6168969604799814000 format: int64 example: deleted_count: 2653253722218076000 required: - deleted_count HarnessIacmWorkspacemodule: type: object properties: invocations: type: integer description: Number of times this module is invoked in the workspace example: 3 format: int64 key: type: string description: Module key example: ec2-instance_test source: type: string description: Module source example: registry.opentofu.org/terraform-aws-modules/ec2-instance/aws//examples/complete stack_path: type: string description: Terragrunt stack path (empty for regular Terraform workspaces) example: environments/prod/ec2 version: type: string description: Module version example: 5.0.0 description: Represents an individual OpenTofu or Terraform module. example: 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 required: - key - source - version - invocations HarnessIacmResource: type: object properties: attributes: type: object description: A map of values related to the resource example: ami: ami-830c94ec instance_type: t2.micro additionalProperties: true createdAt: type: integer description: Timestamp when the resource was created. example: 1627590400 format: int64 drift_attributes: type: object description: A map of values related to the resource example: instance_type: t2.nano additionalProperties: true drift_status: type: string description: Indicates if this resource is experiencing drift. example: changed enum: - changed - deleted - unchanged lastSyncedAt: type: integer description: Timestamp when the resource was last updated. example: 1627686800 format: int64 mode: type: string description: Mode associated with the resource. example: resource enum: - resource - data - output module: type: string description: Module associated with the resource. example: full_stack monthly_cost: type: number description: Current period cost from CCM (null if no cost data). example: 0.5541271992461246 format: double monthly_saving: type: number description: Monthly potential saving from CCM (null if no cost data). example: 0.9269406226835157 format: double name: type: string description: Name associated with the resource. example: app_server path_id: type: string description: Path associated with the resource. Could be namespace, environment or stack id. example: namespace provider: type: string description: Cloud provider associated with the resource. example: AWS recommendation_count: type: integer description: Number of CCM recommendations for this resource (null if no cost data). example: 4349910511062764000 format: int64 resource_id: type: string description: Unique identifier for the resource from the cloud provider. example: arn:aws:s3:::my-bucket sensitive_attributes: type: array items: example: Id hic dolore soluta quo aut qui. description: 'A list of the sensitive attribute keys ' example: - instance_type type: type: string description: Type of the provisioned resource. example: S3 Bucket description: Represents an individual provisioned resource. example: 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.5497077503678112 monthly_saving: 0.8619061769391817 name: app_server path_id: namespace provider: AWS recommendation_count: 7888905466721955000 resource_id: arn:aws:s3:::my-bucket sensitive_attributes: - instance_type type: S3 Bucket required: - provider - type - name - module - mode - path_id - resource_id - attributes - drift_status - drift_attributes - sensitive_attributes ResourceUpdate: type: object properties: attributes: description: Resource attributes example: Ipsa eum tenetur modi qui nobis animi. drift_attributes: type: object description: Map of drifted attribute values (used when update_mode=drift) example: Aliquam eum rerum repudiandae magni consequuntur.: Tenetur est quam eaque. Fugit exercitationem dolore est et.: Sed est nisi voluptatem illum a. Temporibus esse voluptate harum.: Sed ab non dolor et nisi. additionalProperties: true drift_status: type: string description: Drift status of the resource (used when update_mode=drift) example: unchanged enum: - changed - deleted - unchanged - '' mode: type: string description: managed, datasource, output example: Eos exercitationem dolorum a quia. module: type: string description: Module path example: Voluptatum illo nobis velit maiores et eum. name: type: string description: Resource name example: Amet architecto consequatur voluptas. path_id: type: string description: path id example: Et facilis perferendis. provider: type: string description: Provider name example: Fugit perferendis dolore. sensitive_attribute_paths: type: array items: type: string example: Repudiandae consequatur expedita eaque. description: Paths to sensitive attributes example: - Quam quam quisquam sint. - Dicta porro dolores. type: type: string description: Resource type example: Voluptates et est sint quia. description: Resource update information example: attributes: Et quaerat assumenda fugit. drift_attributes: Placeat odit blanditiis eum itaque ea ab.: Assumenda officiis explicabo velit. Repudiandae veritatis magnam.: Molestiae doloribus expedita. Vero ad est.: Quia est. drift_status: changed mode: Ullam omnis ducimus velit. module: Libero nam temporibus commodi expedita sit. name: Unde maxime necessitatibus consequatur quae aut. path_id: Explicabo autem dolorum blanditiis. provider: In repellendus enim vel aliquid in. sensitive_attribute_paths: - Ipsa quo dolores maxime. - Doloribus nam voluptatem molestiae. type: Corporis iste fugiat magnam quod. required: - provider - type - name - module - mode - attributes DeleteDriftConfigResponse: type: object properties: status: type: string description: Outcome message example: Corrupti nam. example: status: Quas at id nihil qui. required: - status IaCMPolicy: type: object properties: account_id: type: string description: Harness account ID associated with this policy default: '' example: eBqAoNchMLKigC_qZ5EdC created: type: integer description: Time the policy was created example: 1636669297674 format: int64 identifier: type: string description: identifier of the policy example: policy-1 minLength: 1 name: type: string description: Name of the policy example: Pipeline Approval minLength: 1 org_id: type: string description: Harness organization ID associated with this policy default: '' example: test-org project_id: type: string description: Harness project ID associated with this policy default: '' example: test-project rego: type: string description: Rego that defines the policy example: '' minLength: 1 updated: type: integer description: Time the policy was last updated example: 1636669297674 format: int64 example: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 required: - identifier - name - rego - created - updated - account_id - org_id - project_id ListPipelinesResponse: type: object properties: account: type: string description: Account is the internal customer account ID. example: uq minLength: 1 maxLength: 128 org: type: string description: Org is the organisation identifier. example: s minLength: 1 maxLength: 128 pipelines: type: array items: type: string example: Excepturi quam illo iusto. description: Array of pipelines that belong to a specific workspace example: - Ipsa fugit ipsam quia est qui. - Dolorem consequatur voluptatem ut laudantium. project: type: string description: Project is the project identifier. example: 4w minLength: 1 maxLength: 128 example: account: yk8 org: byh pipelines: - Soluta rerum. - Pariatur eum. project: '3' required: - account - org - project GetDriftConfigResponse: type: object properties: enabled: type: boolean example: true pipeline_id: type: string example: Repellendus id reiciendis. run_every: type: integer description: Repeat interval; set when schedule is configured example: 3040396512708893700 format: int64 run_every_unit: type: string description: hours or days example: seconds enum: - seconds - minutes - hours - days trigger_id: type: string example: Neque ipsum corporis est facere asperiores. example: enabled: true pipeline_id: Asperiores beatae. run_every: 2883248609136664600 run_every_unit: seconds trigger_id: Sint placeat. required: - enabled UpdateEphemeralConfigResponse: type: object properties: delete_at: type: string description: Computed delete timestamp (ISO 8601), empty if delete_workspace is false example: Quibusdam commodi id ut fugit dolorem. destroy_at: type: string description: Computed destroy timestamp (ISO 8601) example: Nesciunt pariatur beatae hic nihil. status: type: string description: Outcome message example: Esse aspernatur enim harum officia fugit. example: delete_at: Voluptatem omnis laudantium porro ut. destroy_at: Repudiandae voluptatem labore. status: Non laudantium laborum optio delectus illum. required: - status WorkspacesCreateWorkspaceResponseBody: type: object properties: policy_evaluation: $ref: '#/components/schemas/IaCMEvaluation' description: Create-WorkspaceResponseBody result type (default view) example: 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 IaCMVariable: type: object properties: key: type: string description: Key is the identifier for the secret. example: g pattern: ^[A-Za-z_][A-Za-z0-9_-]*$ minLength: 1 maxLength: 128 value: type: string description: Value is the value of the secret. example: Optio aut molestiae laborum ea adipisci. value_type: type: string description: 'Type indecates the value type of the secret. In the case of secret this is a reference to an item in the secret store' example: secret enum: - string - secret description: Variable is the representation for a single variable associated with a workspace. example: key: t value: Quia earum fuga libero delectus fugiat similique. value_type: secret required: - key - value - value_type - kind WorkspaceResourceSummaryCollection: type: array items: $ref: '#/components/schemas/WorkspaceResourceSummary' description: WorkspaceResourceCollection is the result type for an array of WorkspaceResource (summary view) example: - account: tug created: 7506229833280796000 description: this is a more detailed explanation of the resource. identifier: i name: resource name org: gum project: ln status: destroying updated: 3667303828716196400 - account: tug created: 7506229833280796000 description: this is a more detailed explanation of the resource. identifier: i name: resource name org: gum project: ln status: destroying updated: 3667303828716196400 - account: tug created: 7506229833280796000 description: this is a more detailed explanation of the resource. identifier: i name: resource name org: gum project: ln status: destroying updated: 3667303828716196400 SearchResourcesResponse: type: object properties: data_sources: $ref: '#/components/schemas/ResourceCollection' outputs: $ref: '#/components/schemas/OutputCollection' resources: $ref: '#/components/schemas/ResourceCollection' stack_outputs: type: object description: Outputs grouped by stack path for Terragrunt workspaces example: IaCM/TGOverride/environments/dev/ec2: - name: instance_id sensitive: false stack_path: IaCM/TGOverride/environments/dev/ec2 value: i-1234567890abcdef0 additionalProperties: $ref: '#/components/schemas/OutputCollection' total_resources: type: integer description: Total number of resources managed by this workspace default: 0 example: 42 format: int64 example: 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.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 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.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 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: Ipsam occaecati nihil id recusandae modi. - expression: <+outputs.instance_id> name: instance_public_ip sensitive: true stack_path: IaCM/TGOverride/environments/dev/ec2 value: Ipsam occaecati nihil id recusandae modi. - expression: <+outputs.instance_id> name: instance_public_ip sensitive: true stack_path: IaCM/TGOverride/environments/dev/ec2 value: Ipsam occaecati nihil id recusandae modi. 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.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 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.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 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 required: - resources - data_sources - outputs - total_resources ResourceDeleteSummary: type: object properties: deleted: type: integer description: Number of resources successfully deleted example: 2432573194934620700 format: int64 failed: type: integer description: Number of resources that failed to delete example: 5724056068580218000 format: int64 skipped: type: integer description: Number of resources skipped example: 8619421588402426000 format: int64 total: type: integer description: Total number of resources processed example: 5262556688483735000 format: int64 description: Summary of a resource delete operation example: deleted: 8593602235909196000 failed: 5681166280030831000 skipped: 7011959076094795000 total: 775796752030268800 required: - total - deleted - skipped - failed IaCMEvaluatedPolicy: type: object properties: deny_messages: type: array items: type: string example: Rerum et id aperiam nobis. description: The values of any `deny` rego rules as returned by the rego engine example: - deployment stage 'example-stage' does not have a HarnessApproval step - deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: description: The output returned by the rego engine when this policy was evaluated example: "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}" policy: $ref: '#/components/schemas/IaCMPolicy' rego_error: type: string description: Any errors returned by the rego engine when this policy was evaluated example: 'policy.rego:25: rego_parse_error: non-terminated string m == "test' status: type: string description: The overall status for this individual policy indicating whether it passed example: error enum: - error - warning - pass example: 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 required: - status - policy - output - deny_messages - rego_error WorkspaceDataPolicyEvaluation: type: object properties: message: type: string example: Consectetur doloribus est minima. policy_id: type: string example: Deserunt ducimus repudiandae excepturi. policy_name: type: string example: Occaecati accusamus atque magni repudiandae rerum. policy_set_id: type: string example: Aut id necessitatibus aliquam assumenda expedita laborum. policy_set_name: type: string example: In voluptatem. policy_status: type: string example: Consequatur consequatur vel quae fugiat molestiae. example: message: Eum expedita quis. policy_id: Provident minima quibusdam id. policy_name: Optio dolores dicta itaque voluptatem ut. policy_set_id: Non quae. policy_set_name: Nisi culpa ex perferendis omnis a voluptatem. policy_status: Nesciunt praesentium doloribus facilis commodi quos. required: - policy_set_id - policy_set_name - policy_id - policy_name - policy_status - message UploadRiskAssessmentResponse: type: object properties: id: type: string description: The unique identifier for the data example: dc538c61-de48-4220-958c-5f3c4f983daa policy_evaluation: type: array items: $ref: '#/components/schemas/WorkspaceDataPolicyEvaluation' description: Individual policy evaluation details example: - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. policy_evaluation_message: type: string description: Pre-rendered message included when policy evaluation did not pass example: '- instance type ''xlarge'' is not permitted' policy_evaluation_status: type: string description: The overall status of policy evaluation (if it occurred) indicating whether it passed example: error enum: - error - warning - pass example: id: dc538c61-de48-4220-958c-5f3c4f983daa policy_evaluation: - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. policy_evaluation_message: '- instance type ''xlarge'' is not permitted' policy_evaluation_status: error required: - id UpdateDriftConfigRequest: type: object properties: pipeline_id: type: string description: Pipeline to run for drift detection example: Porro et enim quia molestias fugit. provisioner: type: string description: Provisioner key (defaults to opentofu when omitted) example: Sed eos nihil corporis culpa eum qui. run_every: type: integer description: Run drift detection every N hours or N days (see run_every_unit) example: 3034588033869555700 format: int64 run_every_unit: type: string description: hours or days example: days enum: - seconds - minutes - hours - days example: pipeline_id: Libero illum enim saepe officia repellendus. provisioner: Dolores a amet voluptatem tempora amet repellat. run_every: 6589902134771943000 run_every_unit: hours required: - pipeline_id - run_every - run_every_unit ShowRemoteExecutionResponse: type: object properties: account: type: string description: Account is the internal customer account ID. example: et minLength: 1 maxLength: 128 created: type: integer description: Created is the unix timestamp at which the resource was originally created in milliseconds. example: 271968011745559040 format: int64 custom_arguments: type: object description: The arguments supplied to the plan. example: Modi eligendi nisi eum nostrum consectetur.: - Ut alias eum perspiciatis tenetur possimus. - Qui magnam eligendi atque. Placeat iure nihil et libero et.: - Porro est distinctio nihil qui. - Repudiandae aliquam odit. - Adipisci eveniet. Vitae voluptatem at ex.: - Quae facilis libero. - Nisi molestias minus. additionalProperties: type: array items: type: string example: Voluptatem id esse. example: - Voluptatem ut nisi provident et blanditiis sunt. - Est quia enim. - Non eum qui voluptas tenetur quia. executed: type: boolean description: The boolean value indicating if the remote execution has been executed. example: false id: type: string description: The ID of the remote execution. example: 9b3b5f49-2102-47ef-84cc-623d380b5a58 format: uuid org: type: string description: Org is the organisation identifier. example: jn7 minLength: 1 maxLength: 128 pipeline_execution_id: type: string description: The pipeline execution ID of the pipeline executing the remote execution example: Earum itaque voluptatem possimus nihil sit. pipeline_execution_url: type: string description: The pipeline execution URL of the pipeline executing the remote execution example: Non et cupiditate ad quis ex. project: type: string description: Project is the project identifier. example: '9' minLength: 1 maxLength: 128 sha256_checksum: type: string description: The checksum of the patch file of changes that the remote execution will run against. example: Vel provident quibusdam dolores quis sint. updated: type: integer description: Modified is the unix timestamp at which the resource was last modified in milliseconds. example: 7455876492768856000 format: int64 workspace: type: string description: The workspace associated with the remote execution. example: Voluptatem quo nihil provident dicta. example: account: i created: 8732468219752007000 custom_arguments: Autem numquam veniam cumque voluptatum dolor assumenda.: - Vitae cum recusandae provident dolore. - Velit dolores repellat rerum incidunt in libero. - Vitae a. - Id autem nisi voluptates autem. Rem odit.: - Et nesciunt aliquam corporis nostrum rerum. - Saepe aliquid. - Itaque reprehenderit aut. Similique est et sequi tempore accusantium ex.: - Consequuntur qui dolores at. - Omnis suscipit quae et sequi neque dolorum. - Odit soluta quia error delectus sed. executed: true id: 45ee3353-0521-4661-9fb3-b74cda679c8b org: dwj pipeline_execution_id: Consectetur voluptas quisquam eaque ipsum et. pipeline_execution_url: Odio inventore occaecati vitae quasi. project: '0' sha256_checksum: Vitae dolorum ut qui aspernatur. updated: 7689225900218839000 workspace: Vel et vel. required: - account - org - project - id - workspace - pipeline_execution_id - pipeline_execution_url - created - updated - executed - sha256_checksum GetEphemeralConfigResponse: type: object properties: delete_at: type: string description: Scheduled deletion timestamp (ISO 8601) example: Eos nemo qui temporibus quo rem. delete_delay_unit: type: string description: Configured delete delay unit (hours or days) example: days enum: - seconds - minutes - hours - days delete_delay_value: type: integer description: Configured delete delay value (when delete_workspace is true) example: 6733359525593127000 format: int64 delete_on_date: type: string description: Configured delete date (YYYY-MM-DD) when schedule uses a specific date example: Asperiores nostrum illo. delete_workspace: type: boolean description: Whether workspace will be deleted after destroy example: true destroy_at: type: string description: Scheduled destruction timestamp (ISO 8601) example: Voluptatem non velit excepturi. destroy_on_date: type: string description: Configured destroy date (YYYY-MM-DD) when schedule uses a specific date example: Vel molestiae est. enabled: type: boolean example: false pipeline_id: type: string example: Delectus consequatur minima provident sequi beatae. provisioner: type: string description: Provisioner this configuration applies to example: Enim omnis optio itaque voluptates praesentium amet. source: type: string description: 'Origin of the configuration: ''workspace'', ''project'', or ''disabled''' example: project enum: - workspace - project - disabled trigger_id: type: string description: Harness trigger ID for the destroy schedule example: Rerum molestias deserunt eum esse dolores id. ttl_unit: type: string description: Configured destroy delay unit (hours or days) example: seconds enum: - seconds - minutes - hours - days ttl_value: type: integer description: Configured destroy delay value (when schedule uses delay) example: 6305091237110071000 format: int64 example: delete_at: Nihil eveniet quia quia. delete_delay_unit: hours delete_delay_value: 3210605579497261600 delete_on_date: Voluptatem facilis omnis enim omnis. delete_workspace: false destroy_at: Et similique odit vel. destroy_on_date: Dolores atque error quidem. enabled: true pipeline_id: Repellendus molestiae sit iste ut. provisioner: Mollitia omnis et nulla. source: disabled trigger_id: Nisi occaecati tempora natus soluta. ttl_unit: hours ttl_value: 3013753820081507300 required: - enabled SendEventRequest: type: object properties: data: type: object example: Quo dolores eum dolore molestias id.: Fugit consequatur quaerat aut. Rerum autem tenetur recusandae nisi et hic.: Animi laborum animi quo assumenda voluptatem perferendis. additionalProperties: type: string example: Beatae maxime perspiciatis modi sunt et reprehenderit. event_type: type: string description: The type of event that occurred example: failed enum: - plan - drifted - provisioning - destroying - active - inactive - apply_needed - failed - stage-complete metadata: $ref: '#/components/schemas/ActivityMetadata' pipeline_execution_id: type: string description: 'Deprecated: use metadata instead' default: '' example: Aliquid iure odio. pipeline_stage_id: type: string description: 'Deprecated: use metadata instead' default: '' example: Ullam placeat ipsa dolore numquam neque fugiat. example: data: Earum accusamus sed doloribus.: Est eos unde quia quo. event_type: failed metadata: PlannedChangesCount: 7183568001417402000 activity_status: incomplete activity_type: rollback cost_breakdown_uuid: Autem quia consequatur libero voluptas ipsa. cost_currency: Sapiente incidunt animi fuga. cost_diff_total_monthly: Doloremque accusantium officiis qui. cost_diff_uuid: Quod qui soluta tenetur odio quia cupiditate. cost_past_total_monthly: Ad placeat. cost_total_monthly: Earum culpa. cost_total_monthly_percentage_change: Modi corrupti expedita vel. data_length: 4979827047011853000 drift_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 enable_solutions_factory: true git_branch: Maiores ut et vel nihil. git_commit_message: Veritatis et aspernatur iste autem optio. git_commit_sha: Quaerat sint et est consequuntur veritatis. git_repo: Et iste assumenda. modules_uuid: Dolorem eius magni id sint quidem. output_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 pipeline: Est et aut quaerat commodi dolore numquam. pipeline_execution_id: Eos numquam est quia voluptate. pipeline_execution_number: Optio doloribus ut totam. pipeline_name: Ut nemo corrupti et. pipeline_stage_id: Expedita sit. plan_uuid: Soluta eos dolor qui. providers_uuid: Ad facilis reprehenderit cumque consequuntur voluptatem voluptatem. provisioner: Et quam commodi tenetur. provisioner_version: Quo aut voluptatem beatae nisi sapiente. resource_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 rollback_reason: Et odit blanditiis dignissimos qui. rollback_source_id: Doloremque consequatur et. stacks: - assets_uuid: Cumque et nesciunt. drift_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 drift_uuid: Maxime mollitia suscipit ea pariatur. error_message: Necessitatibus dolore. manifest_uuid: Saepe qui sit harum. resource_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 stack_name: A saepe molestiae eveniet sequi sed. stack_outputs: Alias cum magni sit eligendi.: Laboriosam cupiditate blanditiis ratione eos veritatis. Harum earum at.: Aut amet assumenda sint rem neque. Illo nesciunt dicta saepe iste omnis.: Qui eos facere iusto sed eos velit. stack_path: Exercitationem est consequuntur. status: success template_uuid: Quis quis. tree_uuid: Enim assumenda. - assets_uuid: Cumque et nesciunt. drift_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 drift_uuid: Maxime mollitia suscipit ea pariatur. error_message: Necessitatibus dolore. manifest_uuid: Saepe qui sit harum. resource_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 stack_name: A saepe molestiae eveniet sequi sed. stack_outputs: Alias cum magni sit eligendi.: Laboriosam cupiditate blanditiis ratione eos veritatis. Harum earum at.: Aut amet assumenda sint rem neque. Illo nesciunt dicta saepe iste omnis.: Qui eos facere iusto sed eos velit. stack_path: Exercitationem est consequuntur. status: success template_uuid: Quis quis. tree_uuid: Enim assumenda. state_checksum: Sit tenetur non quod iusto et dolorem. state_uuid: Accusantium possimus animi quis dolor et quia. terragrunt_details: - cost_breakdown_uuid: Odio sed nihil illum velit earum quo. cost_currency: Assumenda nesciunt laborum aperiam vero quibusdam. cost_diff_total_monthly: Architecto tempora. cost_diff_uuid: Non neque laborum. cost_past_total_monthly: Possimus expedita saepe. cost_total_monthly: Qui itaque. cost_total_monthly_percentage_change: Voluptas vel sapiente sunt magni est id. drift_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 output_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 path_id: Odit et nihil et fugiat. resource_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 state_file_link: Ullam officia rerum quia. status: Explicabo quod harum id qui sunt. - cost_breakdown_uuid: Odio sed nihil illum velit earum quo. cost_currency: Assumenda nesciunt laborum aperiam vero quibusdam. cost_diff_total_monthly: Architecto tempora. cost_diff_uuid: Non neque laborum. cost_past_total_monthly: Possimus expedita saepe. cost_total_monthly: Qui itaque. cost_total_monthly_percentage_change: Voluptas vel sapiente sunt magni est id. drift_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 output_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 path_id: Odit et nihil et fugiat. resource_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 state_file_link: Ullam officia rerum quia. status: Explicabo quod harum id qui sunt. - cost_breakdown_uuid: Odio sed nihil illum velit earum quo. cost_currency: Assumenda nesciunt laborum aperiam vero quibusdam. cost_diff_total_monthly: Architecto tempora. cost_diff_uuid: Non neque laborum. cost_past_total_monthly: Possimus expedita saepe. cost_total_monthly: Qui itaque. cost_total_monthly_percentage_change: Voluptas vel sapiente sunt magni est id. drift_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 output_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 path_id: Odit et nihil et fugiat. resource_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 state_file_link: Ullam officia rerum quia. status: Explicabo quod harum id qui sunt. - cost_breakdown_uuid: Odio sed nihil illum velit earum quo. cost_currency: Assumenda nesciunt laborum aperiam vero quibusdam. cost_diff_total_monthly: Architecto tempora. cost_diff_uuid: Non neque laborum. cost_past_total_monthly: Possimus expedita saepe. cost_total_monthly: Qui itaque. cost_total_monthly_percentage_change: Voluptas vel sapiente sunt magni est id. drift_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 output_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 path_id: Odit et nihil et fugiat. resource_counts: added: 8657740251323906000 changed: 9068237418008662000 deleted: 2448681591709719600 imported: 8035970708632902000 removed: 5234863390675745000 unchanged: 5294094303092038000 state_file_link: Ullam officia rerum quia. status: Explicabo quod harum id qui sunt. trigger: Non cum iure.: A cum impedit et. Qui aut eaque.: Tempore mollitia et non. pipeline_execution_id: Hic corporis. pipeline_stage_id: Quas minus commodi porro officiis autem. required: - event_type UpdateResourcesRequest: type: object properties: resources: type: array items: $ref: '#/components/schemas/ResourceUpdate' example: - attributes: Placeat et voluptatem dolorum molestias et rerum. drift_attributes: Nostrum aut sint vero.: Ratione placeat temporibus. drift_status: '' mode: Saepe molestiae aperiam. module: Cum dolorem qui aut delectus et. name: Eum qui et perspiciatis nihil voluptatibus. path_id: Quam assumenda a consequuntur harum ipsum officia. provider: Maxime sed. sensitive_attribute_paths: - Voluptatem eum neque debitis tenetur. - Ea harum eveniet rerum ipsa sunt. type: Fuga ut aut voluptatem facere quo veniam. - attributes: Placeat et voluptatem dolorum molestias et rerum. drift_attributes: Nostrum aut sint vero.: Ratione placeat temporibus. drift_status: '' mode: Saepe molestiae aperiam. module: Cum dolorem qui aut delectus et. name: Eum qui et perspiciatis nihil voluptatibus. path_id: Quam assumenda a consequuntur harum ipsum officia. provider: Maxime sed. sensitive_attribute_paths: - Voluptatem eum neque debitis tenetur. - Ea harum eveniet rerum ipsa sunt. type: Fuga ut aut voluptatem facere quo veniam. session_id: type: string description: Session ID to track resource updates belongs to same operation example: c1a610cf-7c00-4926-9147-2c095da7e4a6 format: uuid update_mode: type: string description: 'Update mode: upsert (default) updates attributes; drift updates drift columns only' default: upsert example: drift enum: - upsert - drift example: resources: - attributes: Placeat et voluptatem dolorum molestias et rerum. drift_attributes: Nostrum aut sint vero.: Ratione placeat temporibus. drift_status: '' mode: Saepe molestiae aperiam. module: Cum dolorem qui aut delectus et. name: Eum qui et perspiciatis nihil voluptatibus. path_id: Quam assumenda a consequuntur harum ipsum officia. provider: Maxime sed. sensitive_attribute_paths: - Voluptatem eum neque debitis tenetur. - Ea harum eveniet rerum ipsa sunt. type: Fuga ut aut voluptatem facere quo veniam. - attributes: Placeat et voluptatem dolorum molestias et rerum. drift_attributes: Nostrum aut sint vero.: Ratione placeat temporibus. drift_status: '' mode: Saepe molestiae aperiam. module: Cum dolorem qui aut delectus et. name: Eum qui et perspiciatis nihil voluptatibus. path_id: Quam assumenda a consequuntur harum ipsum officia. provider: Maxime sed. sensitive_attribute_paths: - Voluptatem eum neque debitis tenetur. - Ea harum eveniet rerum ipsa sunt. type: Fuga ut aut voluptatem facere quo veniam. - attributes: Placeat et voluptatem dolorum molestias et rerum. drift_attributes: Nostrum aut sint vero.: Ratione placeat temporibus. drift_status: '' mode: Saepe molestiae aperiam. module: Cum dolorem qui aut delectus et. name: Eum qui et perspiciatis nihil voluptatibus. path_id: Quam assumenda a consequuntur harum ipsum officia. provider: Maxime sed. sensitive_attribute_paths: - Voluptatem eum neque debitis tenetur. - Ea harum eveniet rerum ipsa sunt. type: Fuga ut aut voluptatem facere quo veniam. session_id: 56bf8267-aa77-469e-982f-ba4a6e2031ca update_mode: drift required: - resources ShowWorkspaceMetricsRequest: type: object properties: status_counts: type: object description: Counts by status example: Atque quaerat.: 4243126627130212000 additionalProperties: type: integer example: 3758831569880152600 format: int64 example: status_counts: Dolores voluptas quidem facilis consectetur saepe aut.: 2109936033664810000 Illum magnam asperiores nam voluptas iste vel.: 8971488548516024000 Quidem fugiat dolorum et.: 5387610451354671000 CreateWorkspaceRequest: type: object properties: associated_template: $ref: '#/components/schemas/AssociatedTemplate' budget: type: number description: define the budget for a specific workspace example: 0.6527442 format: float ccm_cost_enabled: type: boolean description: define if CCM cost integration is enabled for this workspace default: false example: true cost_breakdown_json: type: string description: cost_breakdown_json is the identifier to the breakdown cost file from the current execution that was applied successfully example: c4a2d99bc28d236098a095277b7eb0718d6be068 cost_diff_json: type: string description: cost_diff_json is the identifier to the diff cost file between the previous and current successful executions example: c4a2d99bc28d236098a095277b7eb0718d6be068 cost_estimation_enabled: type: boolean description: define if cost estimation operations will be performed in this workspace default: false example: true default_pipelines: type: object description: List of default pipelines associated with this workspace and any per-workspace overrides. example: Est voluptas ut in.: project_pipeline: Et sunt nostrum voluptas nam. workspace_pipeline: Voluptatem aliquid sit rerum et qui autem. Qui aperiam.: project_pipeline: Et sunt nostrum voluptas nam. workspace_pipeline: Voluptatem aliquid sit rerum et qui autem. additionalProperties: $ref: '#/components/schemas/DefaultPipelineOverride' description: type: string description: Description provides long-form text about the resource. example: this is a more detailed explanation of the resource. environment_variables: type: object description: list of environment variables configured on the workspace. example: Rem nulla.: key: nd value: Aut excepturi soluta. value_type: secret Voluptatum maxime minus et beatae.: key: nd value: Aut excepturi soluta. value_type: secret additionalProperties: $ref: '#/components/schemas/IaCMVariable' id: type: integer description: ID PK for internal uses example: 1431480568711395800 format: int64 identifier: type: string description: Workspace identifier. example: b4 minLength: 1 maxLength: 128 modules_json: type: string description: modules_json is the identifier of any modules metadata associated with this workspace example: c4a2d99bc28d236098a095277b7eb0718d6be068 name: type: string description: Name is the human readable name for the resource. example: resource name minLength: 1 maxLength: 128 provider_connector: type: string description: Provider Connector is the reference to the connector for the infrastructure provider. example: Enim vitae amet fuga harum error aut. provider_connectors: type: array items: $ref: '#/components/schemas/WorkspaceProviderConnector' description: define an array of provider connectors that belong to Workspace example: - connector_ref: b3 created: 1627590400 id: 7600418729279140000 terragrunt_provider: false type: vault updated: 1627686800 workspace_id: 7960420049770110000 - connector_ref: b3 created: 1627590400 id: 7600418729279140000 terragrunt_provider: false type: vault updated: 1627686800 workspace_id: 7960420049770110000 - connector_ref: b3 created: 1627590400 id: 7600418729279140000 terragrunt_provider: false type: vault updated: 1627686800 workspace_id: 7960420049770110000 - connector_ref: b3 created: 1627590400 id: 7600418729279140000 terragrunt_provider: false type: vault updated: 1627686800 workspace_id: 7960420049770110000 providers_json: type: string description: providers_json is the identifier of any modules metadata associated with this workspace example: c4a2d99bc28d236098a095277b7eb0718d6be068 provisioner: type: string description: Provisioner defines the provisioning tool to use. example: Deserunt perspiciatis odit labore magnam harum. provisioner_configuration: type: string description: Provisioner configuration metadata (key value pair provisioner specific configuration). example: Soluta consequuntur voluptas hic et veritatis eum. provisioner_version: type: string description: Provisioner Version defines the tool version to use. default: latest example: Omnis esse officiis odio optio dolore vel. prune_sensitive_data: type: boolean description: prune_sensitive_data is a flag to enable or disable pruning of sensitive data default: false example: true repository: type: string description: Repository is the name of the repository to use. example: Aut fugiat enim voluptate reiciendis modi dolorum. repository_branch: type: string description: Repository Branch in which the code should be accessed. example: main repository_commit: type: string description: Repository Commit/Tag in which the code should be accessed. example: abc10ed repository_connector: type: string description: Repository Connector is the reference to the connector to use for this code. example: Neque adipisci quibusdam qui expedita sunt eius. repository_path: type: string description: Repository Path is the path in which the infra code resides. default: '' example: '' repository_sha: type: string description: Repository SHA in which the code should be accessed. example: abc10ed repository_submodules: type: string description: repository_submodules is the instruction about whether to clone submodules in the pipeline step default: 'false' example: recursive enum: - 'false' - 'true' - recursive run_all: type: boolean description: Run-All terragrunt modules. example: false sparse_checkout: type: string description: List of patterens that will be used for sparse checkout option of git clone example: Fugit totam mollitia labore et repudiandae. state_checksum: type: string description: state_checksum is the sha-256 checksum of terraform state file example: d21c1662d8ce2c74f24efdc8db93eb34473b86810aeccca4b1518f70b0ccde8f tags: type: object description: Tags associated with the workspace. example: cost-center: engineering environment: production team: platform additionalProperties: type: string example: Incidunt aliquid odio aut quo. terraform_plan_json: type: string description: terraform_plan_json is the identifier to the current state file only in JSON format. example: f9e21473daaa2674d862b67a1339f4570e86de17 terraform_state: type: string description: terraform_state is the identifier to the plan file used to create the latest state. example: fc1200c7a7aa52109d762a9f005b149abef01479 terraform_state_json: type: string description: terraform_state_json is the identifier to the plan file used to create the latest state only in JSON format. example: c4a2d99bc28d236098a095277b7eb0718d6be068 terraform_variable_files: type: array items: $ref: '#/components/schemas/WorkspaceTerraformVariableFiles' description: define an array of terraform variables files that belong to a different repository example: - repository: Nesciunt asperiores iusto ea dolore id. repository_branch: main repository_commit: abc10ed repository_connector: Suscipit sed eligendi harum. repository_path: '' repository_sha: abc10ed - repository: Nesciunt asperiores iusto ea dolore id. repository_branch: main repository_commit: abc10ed repository_connector: Suscipit sed eligendi harum. repository_path: '' repository_sha: abc10ed - repository: Nesciunt asperiores iusto ea dolore id. repository_branch: main repository_commit: abc10ed repository_connector: Suscipit sed eligendi harum. repository_path: '' repository_sha: abc10ed terraform_variables: type: object description: list of terraform variables configured on the workspace. example: Et illo ut consequatur.: key: nd value: Aut excepturi soluta. value_type: secret Temporibus harum quae aut rerum.: key: nd value: Aut excepturi soluta. value_type: secret additionalProperties: $ref: '#/components/schemas/IaCMVariable' terragrunt_provider: type: boolean description: Whether this workspace uses terragrunt to provision infrastructure default: false example: false terragrunt_version: type: string description: Terragrunt Version to use when provisioner is terragrunt. example: Et quas dignissimos quo. variable_sets: type: array items: type: string example: Quos rem earum earum vitae culpa. description: Attached Variable Sets references example: - Dicta dolor dolor voluptas eveniet ipsam totam. - Molestiae exercitationem dolorem sit dignissimos. example: associated_template: template_id: b version: '4' budget: 0.52185404 ccm_cost_enabled: true cost_breakdown_json: c4a2d99bc28d236098a095277b7eb0718d6be068 cost_diff_json: c4a2d99bc28d236098a095277b7eb0718d6be068 cost_estimation_enabled: true default_pipelines: Et corrupti iure in commodi doloribus ex.: project_pipeline: Et sunt nostrum voluptas nam. workspace_pipeline: Voluptatem aliquid sit rerum et qui autem. Recusandae eligendi animi et nobis quia animi.: project_pipeline: Et sunt nostrum voluptas nam. workspace_pipeline: Voluptatem aliquid sit rerum et qui autem. description: this is a more detailed explanation of the resource. environment_variables: Id voluptate aliquid.: key: nd value: Aut excepturi soluta. value_type: secret id: 4362853738366539000 identifier: '1' modules_json: c4a2d99bc28d236098a095277b7eb0718d6be068 name: resource name provider_connector: Eveniet in nihil laborum at facilis non. provider_connectors: - connector_ref: b3 created: 1627590400 id: 7600418729279140000 terragrunt_provider: false type: vault updated: 1627686800 workspace_id: 7960420049770110000 - connector_ref: b3 created: 1627590400 id: 7600418729279140000 terragrunt_provider: false type: vault updated: 1627686800 workspace_id: 7960420049770110000 providers_json: c4a2d99bc28d236098a095277b7eb0718d6be068 provisioner: Temporibus natus nisi autem eos. provisioner_configuration: Culpa voluptatem. provisioner_version: Asperiores consequatur non molestias. prune_sensitive_data: true repository: Dignissimos eos aut aut quo voluptatibus. repository_branch: main repository_commit: abc10ed repository_connector: Et praesentium error nesciunt impedit minus. repository_path: '' repository_sha: abc10ed repository_submodules: recursive run_all: false sparse_checkout: Odit ut et blanditiis ad. 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: Nesciunt asperiores iusto ea dolore id. repository_branch: main repository_commit: abc10ed repository_connector: Suscipit sed eligendi harum. repository_path: '' repository_sha: abc10ed - repository: Nesciunt asperiores iusto ea dolore id. repository_branch: main repository_commit: abc10ed repository_connector: Suscipit sed eligendi harum. repository_path: '' repository_sha: abc10ed - repository: Nesciunt asperiores iusto ea dolore id. repository_branch: main repository_commit: abc10ed repository_connector: Suscipit sed eligendi harum. repository_path: '' repository_sha: abc10ed - repository: Nesciunt asperiores iusto ea dolore id. repository_branch: main repository_commit: abc10ed repository_connector: Suscipit sed eligendi harum. repository_path: '' repository_sha: abc10ed terraform_variables: Quod omnis accusamus.: key: nd value: Aut excepturi soluta. value_type: secret Voluptates eius autem magnam vitae.: key: nd value: Aut excepturi soluta. value_type: secret Voluptatibus veniam vel omnis.: key: nd value: Aut excepturi soluta. value_type: secret terragrunt_provider: true terragrunt_version: Libero necessitatibus. variable_sets: - Quia consequatur. - Iusto suscipit numquam molestiae voluptatibus. required: - identifier - name - provider_connector - provisioner - terraform_variables - environment_variables ListResourcesResponse: type: object properties: data_sources: $ref: '#/components/schemas/ResourceCollection' outputs: $ref: '#/components/schemas/OutputCollection' resources: $ref: '#/components/schemas/ResourceCollection' stack_outputs: type: object description: Outputs grouped by stack path for Terragrunt workspaces example: IaCM/TGOverride/environments/dev/ec2: - name: instance_id sensitive: false stack_path: IaCM/TGOverride/environments/dev/ec2 value: i-1234567890abcdef0 additionalProperties: $ref: '#/components/schemas/OutputCollection' total_resources: type: integer description: Total number of resources managed by this workspace default: 0 example: 42 format: int64 example: 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.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 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.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 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: Ipsam occaecati nihil id recusandae modi. - expression: <+outputs.instance_id> name: instance_public_ip sensitive: true stack_path: IaCM/TGOverride/environments/dev/ec2 value: Ipsam occaecati nihil id recusandae modi. - expression: <+outputs.instance_id> name: instance_public_ip sensitive: true stack_path: IaCM/TGOverride/environments/dev/ec2 value: Ipsam occaecati nihil id recusandae modi. 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.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 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.32546890397784883 monthly_saving: 0.35814372810159073 name: app_server path_id: namespace provider: AWS recommendation_count: 8335073474648751000 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 required: - resources - data_sources - outputs - total_resources IaCMError: type: object properties: fault: type: boolean description: Is the error a server-side fault? example: false id: type: string description: ID is a unique identifier for this particular occurrence of the problem. example: 123abc message: type: string description: Message is a human-readable explanation specific to this occurrence of the problem. example: parameter 'p' must be an integer name: type: string description: Name is the name of this class of errors. example: bad_request temporary: type: boolean description: Is the error temporary? example: false timeout: type: boolean description: Is the error a timeout? example: true example: fault: false id: 123abc message: parameter 'p' must be an integer name: bad_request temporary: false timeout: true required: - name - id - message - temporary - timeout - fault WorkspacesShowWorkspaceResponseBody: type: object properties: account: type: string description: Account is the internal customer account ID. example: l minLength: 1 maxLength: 128 associated_template: $ref: '#/components/schemas/AssociatedTemplate' backend_locked: type: boolean description: Defines if the remote backend is locked or not default: false example: true budget: type: number description: define the budget for a specific workspace example: 0.9099966 format: float ccm_cost_enabled: type: boolean description: define if CCM cost integration is enabled for this workspace default: false example: false cost_breakdown_json: type: string description: cost_breakdown_json is the identifier to the breakdown cost file from the current execution that was applied successfully example: c4a2d99bc28d236098a095277b7eb0718d6be068 cost_diff_json: type: string description: cost_diff_json is the identifier to the diff cost file between the previous and current successful executions example: c4a2d99bc28d236098a095277b7eb0718d6be068 cost_estimation_enabled: type: boolean description: define if cost estimation operations will be performed in this workspace default: false example: true created: type: integer description: Created is the unix timestamp at which the resource was originally created in milliseconds. example: 5026754182893188000 format: int64 default_pipelines: type: object description: List of default pipelines associated with this workspace and any per-workspace overrides. example: Pariatur molestias eveniet impedit quasi.: project_pipeline: Quam vitae nulla. workspace_pipeline: Dolor velit quo eaque saepe. additionalProperties: $ref: '#/components/schemas/DefaultPipelineOverride' description: type: string description: Description provides long-form text about the resource. example: this is a more detailed explanation of the resource. environment_variables: type: object description: list of environment variables configured on the workspace. example: Sit iure harum et tenetur.: created: 6758585511865266000 key: tg updated: 2953533946315675600 value: Qui quod exercitationem et molestiae. value_type: string additionalProperties: $ref: '#/components/schemas/VariableResource' identifier: type: string description: Workspace identifier. example: 3ls minLength: 1 maxLength: 128 lock: $ref: '#/components/schemas/WorkspaceLock' modules_json: type: string description: modules_json is the identifier of any modules metadata associated with this workspace example: c4a2d99bc28d236098a095277b7eb0718d6be068 name: type: string description: Name is the human readable name for the resource. example: resource name minLength: 1 maxLength: 128 org: type: string description: Org is the organisation identifier. example: 4q minLength: 1 maxLength: 128 project: type: string description: Project is the project identifier. example: o minLength: 1 maxLength: 128 provider_connector: type: string description: Provider Connector is the reference to the connector for the infrastructure provider. example: Eius consequatur nemo doloribus molestias. provider_connectors: type: array items: $ref: '#/components/schemas/WorkspaceProviderConnector' description: define an array of provider connectors that belong to Workspace example: - connector_ref: d7 created: 1627590400 id: 2574819312703867400 terragrunt_provider: true type: azure updated: 1627686800 workspace_id: 3425838825461482000 - connector_ref: d7 created: 1627590400 id: 2574819312703867400 terragrunt_provider: true type: azure updated: 1627686800 workspace_id: 3425838825461482000 providers_json: type: string description: providers_json is the identifier of any modules metadata associated with this workspace example: c4a2d99bc28d236098a095277b7eb0718d6be068 provisioner: type: string description: Provisioner defines the provisioning tool to use. example: Architecto culpa quia. provisioner_configuration: type: string description: Provisioner configuration metadata (key value pair provisioner specific configuration). example: Ea est dolores quia. provisioner_data: type: string example: Harum ea soluta. provisioner_version: type: string description: Provisioner Version defines the tool version to use. default: latest example: Reprehenderit placeat. prune_sensitive_data: type: boolean description: prune_sensitive_data is a flag to enable or disable pruning of sensitive data default: false example: true repository: type: string description: Repository is the name of the repository to use. example: Repellat ut. repository_branch: type: string description: Repository Branch in which the code should be accessed. example: main repository_commit: type: string description: Repository Commit/Tag in which the code should be accessed. example: abc10ed repository_connector: type: string description: Repository Connector is the reference to the connector to use for this code. example: Autem eum et. repository_path: type: string description: Repository Path is the path in which the infra code resides. default: '' example: '' repository_sha: type: string description: Repository SHA in which the code should be accessed. example: abc10ed repository_submodules: type: string description: repository_submodules is the instruction about whether to clone submodules in the pipeline step default: 'false' example: recursive enum: - 'false' - 'true' - recursive run_all: type: boolean description: Run-All terragrunt modules. example: true sparse_checkout: type: string description: List of patterens that will be used for sparse checkout option of git clone example: Nihil aut reprehenderit ipsum iure. state_checksum: type: string description: state_checksum is the sha-256 checksum of terraform state file example: d21c1662d8ce2c74f24efdc8db93eb34473b86810aeccca4b1518f70b0ccde8f status: type: string description: The status of the workspace example: destroying enum: - active - inactive - provisioning - destroying - failed - unknown - rollback_applied tags: type: object description: Tags associated with the workspace. example: cost-center: engineering environment: production team: platform additionalProperties: type: string example: Consequatur labore dolorum rem aut. terraform_plan_json: type: string description: terraform_plan_json is the identifier to the current state file only in JSON format. example: f9e21473daaa2674d862b67a1339f4570e86de17 terraform_state: type: string description: terraform_state is the identifier to the plan file used to create the latest state. example: fc1200c7a7aa52109d762a9f005b149abef01479 terraform_state_json: type: string description: terraform_state_json is the identifier to the plan file used to create the latest state only in JSON format. example: c4a2d99bc28d236098a095277b7eb0718d6be068 terraform_variable_files: type: array items: $ref: '#/components/schemas/WorkspaceTerraformVariableFiles' description: define an array of terraform variables files that belong to a different repository example: - repository: Rerum ipsam qui velit quo eius. repository_branch: main repository_commit: abc10ed repository_connector: Vel sed ea necessitatibus. repository_path: '' repository_sha: abc10ed - repository: Rerum ipsam qui velit quo eius. repository_branch: main repository_commit: abc10ed repository_connector: Vel sed ea necessitatibus. repository_path: '' repository_sha: abc10ed - repository: Rerum ipsam qui velit quo eius. repository_branch: main repository_commit: abc10ed repository_connector: Vel sed ea necessitatibus. repository_path: '' repository_sha: abc10ed terraform_variables: type: object description: list of terraform variables configured on the workspace. example: Exercitationem ullam id ut minus ducimus eligendi.: created: 6758585511865266000 key: tg updated: 2953533946315675600 value: Qui quod exercitationem et molestiae. value_type: string Id exercitationem aut voluptatem facilis aut necessitatibus.: created: 6758585511865266000 key: tg updated: 2953533946315675600 value: Qui quod exercitationem et molestiae. value_type: string Necessitatibus eligendi reiciendis error molestiae provident quos.: created: 6758585511865266000 key: tg updated: 2953533946315675600 value: Qui quod exercitationem et molestiae. value_type: string additionalProperties: $ref: '#/components/schemas/VariableResource' terragrunt_provider: type: boolean description: Whether this workspace uses terragrunt to provision infrastructure default: false example: true terragrunt_version: type: string description: Terragrunt Version to use when provisioner is terragrunt. example: Voluptatem ut exercitationem animi consequatur incidunt et. updated: type: integer description: Modified is the unix timestamp at which the resource was last modified in milliseconds. example: 7295237747247931000 format: int64 variable_sets: type: array items: type: string example: Excepturi debitis aspernatur velit quisquam et. description: Attached Variable Sets references example: - Repellendus itaque consectetur consequatur. - Quia nobis sint est recusandae illum sunt. - Sit ut fugit. - Sapiente voluptate aut vel qui. description: Show-WorkspaceResponseBody result type (default view) example: account: yqi associated_template: template_id: u version: jkj backend_locked: false budget: 0.96501625 ccm_cost_enabled: false cost_breakdown_json: c4a2d99bc28d236098a095277b7eb0718d6be068 cost_diff_json: c4a2d99bc28d236098a095277b7eb0718d6be068 cost_estimation_enabled: true created: 7681800508219966000 default_pipelines: Et assumenda delectus vero nesciunt odit id.: project_pipeline: Quam vitae nulla. workspace_pipeline: Dolor velit quo eaque saepe. Qui minima et dolorum illo esse.: project_pipeline: Quam vitae nulla. workspace_pipeline: Dolor velit quo eaque saepe. description: this is a more detailed explanation of the resource. environment_variables: Cupiditate voluptas quo facere porro.: created: 6758585511865266000 key: tg updated: 2953533946315675600 value: Qui quod exercitationem et molestiae. value_type: string Sunt nemo modi expedita laudantium voluptas.: created: 6758585511865266000 key: tg updated: 2953533946315675600 value: Qui quod exercitationem et molestiae. value_type: string Voluptatem officia eos quo dignissimos debitis.: created: 6758585511865266000 key: tg updated: 2953533946315675600 value: Qui quod exercitationem et molestiae. value_type: string identifier: 4z lock: created_at: 5023311621798248000 id: Atque fuga. locked_by_display_name: Minima id rerum illo. locked_by_principal_id: Temporibus omnis culpa omnis debitis et et. locked_by_principal_type: Dolor quibusdam qui eos praesentium ea. manual: false reason: Doloribus laudantium nisi. modules_json: c4a2d99bc28d236098a095277b7eb0718d6be068 name: resource name org: w5w project: ca provider_connector: Sint et incidunt ut. provider_connectors: - connector_ref: d7 created: 1627590400 id: 2574819312703867400 terragrunt_provider: true type: azure updated: 1627686800 workspace_id: 3425838825461482000 - connector_ref: d7 created: 1627590400 id: 2574819312703867400 terragrunt_provider: true type: azure updated: 1627686800 workspace_id: 3425838825461482000 providers_json: c4a2d99bc28d236098a095277b7eb0718d6be068 provisioner: Exercitationem esse aspernatur voluptate qui. provisioner_configuration: Quia harum corporis ex qui. provisioner_data: Sed nihil sit est ipsum culpa. provisioner_version: Quia illo et fugit. prune_sensitive_data: true repository: Magni harum praesentium cum eos quis. repository_branch: main repository_commit: abc10ed repository_connector: Voluptates nemo quasi eos cupiditate. repository_path: '' repository_sha: abc10ed repository_submodules: recursive run_all: true sparse_checkout: Qui voluptatem nesciunt voluptas vero explicabo ut. state_checksum: d21c1662d8ce2c74f24efdc8db93eb34473b86810aeccca4b1518f70b0ccde8f status: destroying tags: cost-center: engineering environment: production team: platform terraform_plan_json: f9e21473daaa2674d862b67a1339f4570e86de17 terraform_state: fc1200c7a7aa52109d762a9f005b149abef01479 terraform_state_json: c4a2d99bc28d236098a095277b7eb0718d6be068 terraform_variable_files: - repository: Rerum ipsam qui velit quo eius. repository_branch: main repository_commit: abc10ed repository_connector: Vel sed ea necessitatibus. repository_path: '' repository_sha: abc10ed - repository: Rerum ipsam qui velit quo eius. repository_branch: main repository_commit: abc10ed repository_connector: Vel sed ea necessitatibus. repository_path: '' repository_sha: abc10ed terraform_variables: Et exercitationem est laboriosam rerum quidem rerum.: created: 6758585511865266000 key: tg updated: 2953533946315675600 value: Qui quod exercitationem et molestiae. value_type: string Voluptatem harum repudiandae tempore aut.: created: 6758585511865266000 key: tg updated: 2953533946315675600 value: Qui quod exercitationem et molestiae. value_type: string terragrunt_provider: false terragrunt_version: Quia ut repellat. updated: 4208784123087062000 variable_sets: - Veritatis ut occaecati dolore distinctio autem consectetur. - Perspiciatis quia. - Voluptatem id voluptas culpa eum ea. required: - account - org - project - identifier - name - provider_connector - provisioner - repository_connector - terraform_variables - environment_variables - created - updated - provisioner_data - status - tags Counts: type: object properties: added: type: integer description: Number added example: 8202973261048208000 format: int64 changed: type: integer description: Number changed example: 3750528030447931000 format: int64 deleted: type: integer description: Number deleted example: 3945550675960151600 format: int64 imported: type: integer description: Number imported example: 1253920658304587500 format: int64 removed: type: integer description: Number removed example: 8929890513072264000 format: int64 unchanged: type: integer description: Number unchanged example: 7693111110648153000 format: int64 example: added: 1445466698255948300 changed: 1483170671574748400 deleted: 1633037705295360300 imported: 6005957526700420000 removed: 8167057943775999000 unchanged: 8857189691969749000 required: - added - changed - deleted - unchanged CreateRemoteExecutionRequest: type: object properties: custom_arguments: type: object description: The arguments supplied to the plan. example: Molestiae unde libero id minus fugit.: - Sunt nam aperiam doloremque veniam aut. - Consequuntur nihil libero et. Temporibus id.: - Aspernatur id in delectus nisi aliquid saepe. - Nesciunt maiores. additionalProperties: type: array items: type: string example: Et vero fugiat voluptatem velit ut. example: - Aut veniam aut quidem molestiae nemo. - Officia enim molestias dolores id. - Quaerat assumenda mollitia animi non. - Modi rerum sit. example: custom_arguments: Eveniet voluptas ratione delectus et aut.: - Velit sed. - Ipsum quisquam. Molestiae iure ut fugit odit molestiae illo.: - Natus quod aut voluptatum nihil mollitia. - Nulla rem ea alias. - Earum iste. - Et sit vel ipsam id omnis. Ullam dignissimos deserunt commodi earum nam.: - Distinctio nobis saepe ut enim. - Hic nisi deleniti dolores aliquam cum laborum. - Quibusdam id. - Recusandae recusandae aliquid sed. required: - id - pipeline_execution_id - pipeline_execution_url - created - updated - executed - sha256_checksum EvaluateDataResponse: type: object properties: id: type: string description: The unique identifier for the data example: dc538c61-de48-4220-958c-5f3c4f983daa policy_evaluation: type: array items: $ref: '#/components/schemas/WorkspaceDataPolicyEvaluation' description: Individual policy evaluation details example: - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. policy_evaluation_message: type: string description: Pre-rendered message included when policy evaluation did not pass example: '- instance type ''xlarge'' is not permitted' policy_evaluation_status: type: string description: The overall status of policy evaluation (if it occurred) indicating whether it passed example: error enum: - error - warning - pass example: id: dc538c61-de48-4220-958c-5f3c4f983daa policy_evaluation: - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. policy_evaluation_message: '- instance type ''xlarge'' is not permitted' policy_evaluation_status: error required: - id WorkspaceTerraformVariableFiles: type: object properties: repository: type: string description: Repository is the name of the repository to use. example: Rerum sit distinctio ut. repository_branch: type: string description: Repository Branch in which the code should be accessed. example: main repository_commit: type: string description: Repository Commit/Tag in which the code should be accessed. example: abc10ed repository_connector: type: string description: Repository Connector is the reference to the connector to use for this code. example: Consequuntur reiciendis vitae. repository_path: type: string description: Repository Path is the path in which the infra code resides. default: '' example: '' repository_sha: type: string description: Repository SHA in which the code should be accessed. example: abc10ed description: WorkspaceTerraformVarFiles defines a variable file that lives in another repository than the workspace files. example: repository: Quo nam possimus. repository_branch: main repository_commit: abc10ed repository_connector: Voluptatum repellendus soluta veniam voluptas. repository_path: '' repository_sha: abc10ed required: - repository UpdateDriftConfigResponse: type: object properties: status: type: string description: Outcome message example: Ex expedita ea itaque deserunt voluptate provident. example: status: Ut similique id facere. required: - status IaCMEvaluation: type: object properties: account_id: type: string description: The Harness account in which the evaluation was performed example: XRQAjvT37acOiXx9PRaQMF action: type: string description: The action that triggered evaluation example: onrun created: type: integer description: The time at which the evaluation was performed in Unix time milliseconds example: 1636370209475 format: int64 details: type: array items: $ref: '#/components/schemas/IaCMEvaluationDetail' description: The detailed results of te evaluation example: - 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: type: string description: An arbitrary user-supplied string that globally identifies the entity under evaluation example: 7bbca5d4-e9f2-4955-9b2a-019ec4d3645e entity_metadata: type: string description: Additional arbitrary user-supplied metadata about the entity under evaluation example: 7bbca5d4-e9f2-4955-9b2a-019ec4d3645e id: type: integer description: The ID of this evaluation example: 123 format: int64 input: description: The input provided at evaluation time example: '' org_id: type: string description: The Harness organisation in which the evaluation was performed example: test-org project_id: type: string description: The Harness project in which the evaluation was performed example: test-project status: type: string description: The overall status of the evaluation indicating whether it passed example: error enum: - error - warning - pass type: type: string description: The types of the entity under evaluation example: pipeline,service description: The result of a single evaluation example: account_id: XRQAjvT37acOiXx9PRaQMF action: onrun created: 1636370209475 details: - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - deployment stage 'example-stage' does not have a HarnessApproval step - deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}" policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: 'policy.rego:25: rego_parse_error: non-terminated string m == "test' status: error - deny_messages: - deployment stage 'example-stage' does not have a HarnessApproval step - deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}" policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: 'policy.rego:25: rego_parse_error: non-terminated string m == "test' status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 - account_id: eBqAoNchMLKigC_qZ5EdC action: onrun created: 1636669297674 description: Captures critical production policies details: - deny_messages: - deployment stage 'example-stage' does not have a HarnessApproval step - deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}" policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: 'policy.rego:25: rego_parse_error: non-terminated string m == "test' status: error - deny_messages: - deployment stage 'example-stage' does not have a HarnessApproval step - deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript' output: "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}" policy: account_id: eBqAoNchMLKigC_qZ5EdC created: 1636669297674 identifier: policy-1 name: Pipeline Approval org_id: test-org project_id: test-project rego: '' updated: 1636669297674 rego_error: 'policy.rego:25: rego_parse_error: non-terminated string m == "test' status: error enabled: true identifier: policyset-1 name: Production Policies org_id: test-org project_id: test-project status: error type: pipeline updated: 1636669297674 entity: 7bbca5d4-e9f2-4955-9b2a-019ec4d3645e entity_metadata: 7bbca5d4-e9f2-4955-9b2a-019ec4d3645e id: 123 input: '' org_id: test-org project_id: test-project status: error type: pipeline,service required: - id - status - entity - entity_metadata - type - action - account_id - org_id - project_id - created - input - details UploadRemoteExecutionResponse: type: object properties: account: type: string description: Account is the internal customer account ID. example: 41z minLength: 1 maxLength: 128 created: type: integer description: Created is the unix timestamp at which the resource was originally created in milliseconds. example: 165361142418963100 format: int64 custom_arguments: type: object description: The arguments supplied to the plan. example: At expedita eveniet esse commodi.: - Doloribus eum sit et et. - Sed corporis fuga eum. - Reiciendis asperiores eveniet earum deserunt perspiciatis. Ut non occaecati molestiae.: - Quaerat laudantium et repudiandae occaecati voluptas sed. - Possimus autem voluptatem assumenda itaque. additionalProperties: type: array items: type: string example: Doloribus earum sit. example: - Vel soluta culpa voluptatem. - Vel nostrum ut molestiae aliquid. executed: type: boolean description: The boolean value indicating if the remote execution has been executed. example: false id: type: string description: The ID of the remote execution. example: 99cc8573-cd36-445a-b53a-5f116bd0c8a6 format: uuid org: type: string description: Org is the organisation identifier. example: k9i minLength: 1 maxLength: 128 pipeline_execution_id: type: string description: The pipeline execution ID of the pipeline executing the remote execution example: Rerum ea reprehenderit sit enim. pipeline_execution_url: type: string description: The pipeline execution URL of the pipeline executing the remote execution example: Perferendis et voluptates quia et. project: type: string description: Project is the project identifier. example: eb minLength: 1 maxLength: 128 sha256_checksum: type: string description: The checksum of the patch file of changes that the remote execution will run against. example: Error praesentium soluta optio minus illum sint. updated: type: integer description: Modified is the unix timestamp at which the resource was last modified in milliseconds. example: 1738118988797953800 format: int64 workspace: type: string description: The workspace associated with the remote execution. example: Et ut sit dolorem. example: account: xt created: 2264143297016755500 custom_arguments: In error maiores sequi sit consequatur magnam.: - Doloribus aut nam fuga. - Enim magni aut qui quo perferendis. - Placeat hic rerum perferendis. - Dolorum facere sunt ipsa rerum omnis eum. Voluptatibus et et rem necessitatibus eos.: - Ut possimus. - Eius veniam omnis perspiciatis iure. - Incidunt doloribus corrupti dolores. executed: true id: 9ce10e01-0989-406b-8f4f-9ad12e99b61c org: '3' pipeline_execution_id: Debitis qui delectus. pipeline_execution_url: Voluptate eveniet non. project: 5j8 sha256_checksum: Blanditiis eius et esse dolorum. updated: 7194215559774520000 workspace: Est eius. required: - account - org - project - id - workspace - pipeline_execution_id - pipeline_execution_url - created - updated - executed - sha256_checksum OutputCollection: type: array items: $ref: '#/components/schemas/HarnessIacmOutput' example: - expression: <+outputs.instance_id> name: instance_public_ip sensitive: true stack_path: IaCM/TGOverride/environments/dev/ec2 value: Ipsam occaecati nihil id recusandae modi. - expression: <+outputs.instance_id> name: instance_public_ip sensitive: true stack_path: IaCM/TGOverride/environments/dev/ec2 value: Ipsam occaecati nihil id recusandae modi. - expression: <+outputs.instance_id> name: instance_public_ip sensitive: true stack_path: IaCM/TGOverride/environments/dev/ec2 value: Ipsam occaecati nihil id recusandae modi. - expression: <+outputs.instance_id> name: instance_public_ip sensitive: true stack_path: IaCM/TGOverride/environments/dev/ec2 value: Ipsam occaecati nihil id recusandae modi. ResourcesSelectorConditions: type: object properties: attribute: type: string description: Attribute is the attribute to select on. example: <+attributes.region> operator: type: string description: Operator is the operator to use for the selector. example: equals enum: - equals - not_equals - contains - not_contains - starts_with - ends_with value: type: string description: Value is the value to check. example: europe example: attribute: <+attributes.region> operator: equals value: europe required: - attribute - operator - value CloneWorkspaceRequest: type: object properties: identifier: type: string description: Workspace identifier. example: wj pattern: ^[A-Za-z_][A-Za-z0-9_-]*$ minLength: 1 maxLength: 128 name: type: string description: Name is the human readable name for the resource. example: resource name pattern: ^[A-Za-z_][A-Za-z0-9_ -]*$ minLength: 1 maxLength: 128 example: identifier: d name: resource name required: - identifier - name WorkspaceProviderConnector: type: object properties: connector_ref: type: string description: Connector reference in harness platform. example: u3 minLength: 1 maxLength: 128 created: type: integer description: Timestamp when the connector was created. example: 1627590400 format: int64 id: type: integer description: ID PK for internal uses example: 3651224886971211300 format: int64 terragrunt_provider: type: boolean description: Whether this workspace uses terragrunt to provision infrastructure default: false example: true type: type: string description: Type indicates the connector type. example: azure enum: - aws - azure - gcp - vault updated: type: integer description: Timestamp when the connector was last updated. example: 1627686800 format: int64 workspace_id: type: integer description: Workspace ID FK for internal uses example: 162720591196796600 format: int64 description: Workspace provider connector example: connector_ref: bw created: 1627590400 id: 6733439495693303000 terragrunt_provider: false type: vault updated: 1627686800 workspace_id: 2299650550592903700 required: - connector_ref - type UpdateResourcesResponse: type: object properties: results: type: array items: $ref: '#/components/schemas/ResourceUpdateResult' example: - error: Quis quae ut atque et nemo. mode: Natus a error. module: Dicta omnis sint qui. name: Neque cumque esse dicta eos in. provider: Possimus sed illum illum dicta consequatur. status: skipped type: Consequatur quia quia et explicabo aut. - error: Quis quae ut atque et nemo. mode: Natus a error. module: Dicta omnis sint qui. name: Neque cumque esse dicta eos in. provider: Possimus sed illum illum dicta consequatur. status: skipped type: Consequatur quia quia et explicabo aut. - error: Quis quae ut atque et nemo. mode: Natus a error. module: Dicta omnis sint qui. name: Neque cumque esse dicta eos in. provider: Possimus sed illum illum dicta consequatur. status: skipped type: Consequatur quia quia et explicabo aut. - error: Quis quae ut atque et nemo. mode: Natus a error. module: Dicta omnis sint qui. name: Neque cumque esse dicta eos in. provider: Possimus sed illum illum dicta consequatur. status: skipped type: Consequatur quia quia et explicabo aut. summary: $ref: '#/components/schemas/ResourceUpdateSummary' example: results: - error: Quis quae ut atque et nemo. mode: Natus a error. module: Dicta omnis sint qui. name: Neque cumque esse dicta eos in. provider: Possimus sed illum illum dicta consequatur. status: skipped type: Consequatur quia quia et explicabo aut. - error: Quis quae ut atque et nemo. mode: Natus a error. module: Dicta omnis sint qui. name: Neque cumque esse dicta eos in. provider: Possimus sed illum illum dicta consequatur. status: skipped type: Consequatur quia quia et explicabo aut. - error: Quis quae ut atque et nemo. mode: Natus a error. module: Dicta omnis sint qui. name: Neque cumque esse dicta eos in. provider: Possimus sed illum illum dicta consequatur. status: skipped type: Consequatur quia quia et explicabo aut. summary: failed: 3209551945199997400 skipped: 5371041077206878000 total: 2670516380320101000 updated: 8521338423719211000 required: - results - summary SearchResourcesRequest: type: object properties: limit: type: integer description: Limit is the number of records to return for a page. When omitted, all records are returned. example: 30 format: int64 minimum: 1 maximum: 1000 page: type: integer description: Page is the page number to return relative to the page 'limit'. When omitted, all records are returned. example: 1 format: int64 minimum: 1 selectors: type: array items: $ref: '#/components/schemas/ResourcesSelector' example: - 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 - include_conditions: - attribute: tag.environment operator: equals value: prod path_id: qa provider: aws resource_type: aws_instance search_text: some text example: 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 - include_conditions: - attribute: tag.environment operator: equals value: prod path_id: qa provider: aws resource_type: aws_instance search_text: some text DeleteResourcesResponse: type: object properties: results: type: array items: $ref: '#/components/schemas/ResourceDeleteResult' example: - error: Sunt debitis alias incidunt architecto fugiat. module: Fugit labore dolor quo voluptas laboriosam. name: Non vero nesciunt ut eos ut iste. provider: Voluptatem quasi sequi sint hic sit libero. status: deleted type: Maiores aut omnis autem numquam incidunt nesciunt. - error: Sunt debitis alias incidunt architecto fugiat. module: Fugit labore dolor quo voluptas laboriosam. name: Non vero nesciunt ut eos ut iste. provider: Voluptatem quasi sequi sint hic sit libero. status: deleted type: Maiores aut omnis autem numquam incidunt nesciunt. - error: Sunt debitis alias incidunt architecto fugiat. module: Fugit labore dolor quo voluptas laboriosam. name: Non vero nesciunt ut eos ut iste. provider: Voluptatem quasi sequi sint hic sit libero. status: deleted type: Maiores aut omnis autem numquam incidunt nesciunt. - error: Sunt debitis alias incidunt architecto fugiat. module: Fugit labore dolor quo voluptas laboriosam. name: Non vero nesciunt ut eos ut iste. provider: Voluptatem quasi sequi sint hic sit libero. status: deleted type: Maiores aut omnis autem numquam incidunt nesciunt. summary: $ref: '#/components/schemas/ResourceDeleteSummary' example: results: - error: Sunt debitis alias incidunt architecto fugiat. module: Fugit labore dolor quo voluptas laboriosam. name: Non vero nesciunt ut eos ut iste. provider: Voluptatem quasi sequi sint hic sit libero. status: deleted type: Maiores aut omnis autem numquam incidunt nesciunt. - error: Sunt debitis alias incidunt architecto fugiat. module: Fugit labore dolor quo voluptas laboriosam. name: Non vero nesciunt ut eos ut iste. provider: Voluptatem quasi sequi sint hic sit libero. status: deleted type: Maiores aut omnis autem numquam incidunt nesciunt. summary: deleted: 3056372905831230500 failed: 1058023892543537200 skipped: 2913497782223108000 total: 8126230770775416000 required: - results - summary CreateDataResponse: type: object properties: id: type: string description: The unique identifier for the data example: dc538c61-de48-4220-958c-5f3c4f983daa policy_evaluation: type: array items: $ref: '#/components/schemas/WorkspaceDataPolicyEvaluation' description: Individual policy evaluation details example: - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. policy_evaluation_message: type: string description: Pre-rendered message included when policy evaluation did not pass example: '- instance type ''xlarge'' is not permitted' policy_evaluation_status: type: string description: The overall status of policy evaluation (if it occurred) indicating whether it passed example: error enum: - error - warning - pass example: id: dc538c61-de48-4220-958c-5f3c4f983daa policy_evaluation: - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. - message: Fuga sunt enim nostrum. policy_id: Ut aliquam neque inventore sapiente repudiandae. policy_name: Aut odio. policy_set_id: Veritatis esse rem dicta facilis libero. policy_set_name: Perferendis voluptas. policy_status: Neque vitae quia. policy_evaluation_message: '- instance type ''xlarge'' is not permitted' policy_evaluation_status: error required: - id DeleteStaleResourcesRequest: type: object properties: session_id: type: string description: Current session ID - resources not matching this will be deleted example: b96830e5-7595-421a-92ec-061b0e03843e format: uuid example: session_id: bd886b4c-666a-4ae5-bdfb-8b68718fab43 required: - session_id DeleteResourcesRequest: type: object properties: resources: type: array items: $ref: '#/components/schemas/ResourceDelete' example: - module: Laboriosam iure excepturi quam. name: Dignissimos dolorum velit et porro pariatur. path_id: At quia harum exercitationem non. provider: Sint aut odit vel distinctio. type: Voluptatem deserunt ut veniam consequatur et facere. - module: Laboriosam iure excepturi quam. name: Dignissimos dolorum velit et porro pariatur. path_id: At quia harum exercitationem non. provider: Sint aut odit vel distinctio. type: Voluptatem deserunt ut veniam consequatur et facere. example: resources: - module: Laboriosam iure excepturi quam. name: Dignissimos dolorum velit et porro pariatur. path_id: At quia harum exercitationem non. provider: Sint aut odit vel distinctio. type: Voluptatem deserunt ut veniam consequatur et facere. - module: Laboriosam iure excepturi quam. name: Dignissimos dolorum velit et porro pariatur. path_id: At quia harum exercitationem non. provider: Sint aut odit vel distinctio. type: Voluptatem deserunt ut veniam consequatur et facere. - module: Laboriosam iure excepturi quam. name: Dignissimos dolorum velit et porro pariatur. path_id: At quia harum exercitationem non. provider: Sint aut odit vel distinctio. type: Voluptatem deserunt ut veniam consequatur et facere. - module: Laboriosam iure excepturi quam. name: Dignissimos dolorum velit et porro pariatur. path_id: At quia harum exercitationem non. provider: Sint aut odit vel distinctio. type: Voluptatem deserunt ut veniam consequatur et facere. required: - resources ResourceUpdateResult: type: object properties: error: type: string example: Soluta doloremque deleniti similique. mode: type: string example: Et non maiores illo est ad in. module: type: string example: Delectus quidem et nihil ut. name: type: string example: Laboriosam et doloremque. provider: type: string example: Veritatis repudiandae. status: type: string example: failed enum: - updated - skipped - failed type: type: string example: Eius rem. description: Result of a resource update operation example: error: Consequatur illum maiores est sit sit. mode: Laboriosam accusamus enim quia quis expedita. module: Sed atque est minima libero recusandae voluptatem. name: Aut quasi dolores deleniti minus aut rerum. provider: Impedit dolores animi perferendis minima. status: skipped type: Ea deserunt voluptates eius deserunt. required: - provider - type - name - module - mode WorkspaceResourceSummary: type: object properties: account: type: string description: Account is the internal customer account ID. example: k minLength: 1 maxLength: 128 created: type: integer description: Created is the unix timestamp at which the resource was originally created in milliseconds. example: 1046371060765529700 format: int64 description: type: string description: Description provides long-form text about the resource. example: this is a more detailed explanation of the resource. identifier: type: string description: Workspace identifier. example: yk minLength: 1 maxLength: 128 name: type: string description: Name is the human readable name for the resource. example: resource name minLength: 1 maxLength: 128 org: type: string description: Org is the organisation identifier. example: 4ep minLength: 1 maxLength: 128 project: type: string description: Project is the project identifier. example: bf minLength: 1 maxLength: 128 status: type: string description: The status of the workspace example: unknown enum: - active - inactive - provisioning - destroying - failed - unknown - rollback_applied updated: type: integer description: Modified is the unix timestamp at which the resource was last modified in milliseconds. example: 3188135367575674400 format: int64 description: WorkspaceResource is the representation for a single workspace definition. (summary view) example: account: fo created: 6045901660041005000 description: this is a more detailed explanation of the resource. identifier: 03z name: resource name org: rgg project: y54 status: inactive updated: 2989163535342006300 required: - account - org - project - identifier - name - created - updated - status WorkspaceModuleCollection: type: array items: $ref: '#/components/schemas/HarnessIacmWorkspacemodule' example: - 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 - 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 ResourceDeleteResult: type: object properties: error: type: string example: Dolore dolorem veritatis a eaque. module: type: string example: Consequatur qui perspiciatis nulla. name: type: string example: Laudantium fuga dignissimos eos fugiat minima provident. provider: type: string example: Nesciunt molestiae assumenda fugit sint alias. status: type: string example: failed enum: - deleted - skipped - failed type: type: string example: Ad laboriosam. description: Result of a resource delete operation example: error: Ut earum cumque sunt a. module: Aut omnis. name: Aut voluptatum temporibus recusandae culpa quia. provider: Voluptatum fuga facere. status: skipped type: Labore repudiandae veniam quos. required: - provider - type - name - module securitySchemes: x-api-key: name: x-api-key type: apiKey in: header description: API key is a token provided while making the API calls. This is used to authenticate the client at the exposed endpoint. externalDocs: description: Find out more about Swagger url: http://swagger.io x-stoplight: id: oc91t4vrfnjyi x-tagGroups: - name: Organizations tags: - Organization - name: Projects tags: - Org Project - Project - name: Secrets tags: - Account Secret - Org Secret - Project Secret - Secrets - name: Connectors tags: - Account Connector - Org Connector - Project Connector - Connectors - GoogleSecretManagerConnector - name: Roles tags: - Account Roles - Organization Roles - Project Roles - Roles - name: Resource Groups tags: - Account Resource Groups - Organization Resource Groups - Project Resource Groups - Filter Resource Groups - Harness Resource Group - Zendesk - name: Role Assignments tags: - Account Role Assignments - Org Role Assignments - Project Role Assignments - Role Assignments - name: Platform tags: - Access Control List - Account Banner - Account Banner - Account Licensed Modules - Account License Type - Account Webhooks - AccountSetting - Accounts - Analyze Account Access Policy - Analyze Organization Access Policy - Analyze Project Access Policy - ApiKey - Audit - AuditFilters - Authentication Settings - Canny - Devops Essentials License Data By Account - EULA - Filter - Harness Resource Type - Invite - IP Allowlist - Nextgen Ldap - Notification Channels - Notification Rules - OIDC - Oidc-Access-Token - Oidc-ID-Token - Org Webhooks - Permissions - Project Webhooks - Secret Managers - Service Account - Setting - SMTP - Source Code Manager - Token - User - User Group - Variables - name: Delegate tags: - Agent mTLS Endpoint Management - Delegate Download Resource - Delegate Group Tags Resource - Delegate Setup Resource - Delegate Token Resource - name: Pipelines tags: - Pipelines - Input Sets - Approvals - Pipeline Execution - Pipeline Dashboard - Pipeline Input Set - Pipeline - Pipeline Execution Details - Pipeline Execute - Pipeline Refresh - Pipeline data retention - Triggers - TriggersEvents - Webhook Triggers - Webhook Event Handler - DryRunPipeline - name: Artifact Registry tags: - Registries - Artifacts - Docker Artifacts - Helm Artifacts - quarantine - Webhooks - Spaces - Replication - Registry V3 - Registries - Registry V3 - Packages - Registry V3 - Versions - Registry V3 - Files - Registry V3 - Metadata - Registry V3 - Firewall - Registry V3 - Transfer - name: Database DevOps tags: - Database Schema - Database Instance - Deployed State - Execution Config - Migration State - name: CD tags: - K8s Release Service Mapping - CustomDeployment - Environments - EnvironmentGroup - Infrastructures - Usage - File Store - Service Dashboard - ServiceOverrides - Rollback - tas - name: Deployment Freeze tags: - Freeze CRUD - Freeze Evaluation - Freeze Schema - name: Services tags: - Account Services - Org Services - Project Services - Services - name: Rancher Infrastructures tags: - Account Rancher Infrastructure - Org Rancher Infrastructure - Project Rancher Infrastructure - name: Templates tags: - Account Template - Org Template - Project Template - Templates - Global Templates - name: GitOps tags: - Agents - Application - Applications - Certificates - Clusters - Dashboard Aggregates - Dashboards - GnuPGP Keys - GPG Keys - Hosts - Project mappings - Projects - Reconciler - Repositories - Repository Certificates - Repository credentials - ValidateHost - name: GitX tags: - GitX Webhooks - Org Gitx Webhooks - Project Gitx Webhooks - name: CACM tags: - Anomalies Ignorelist Rule - Anomalies - BI Dashboards - Budgets - Budget Groups - Cost Categories - Cloud Accounts - K8S Connectors Metadata - Notification Settings v2 - Overview - Data Job Status - Recommendation cost settings - Unit Metric - Anomaly Comments - Cloud and AI cost anomaly details - Cloud and AI cost anomalies v2 - Cost Details - Currency Preferences - External Data Provider - AiEngine - CACM governance cost settings - Governance Enforcement Recommendation APIs - Governance Alert - Governance Overview - Governance Recommendation APIs - RuleEnforcement - Rule Executions - Rule - Rule Sets - Perspectives Folders - Perspective Reports - Perspectives - Cost Category Jira Project Mapping - Recommendations Details - Recommendations - Recommendation Jira - Recommendation Preferences - Recommendation Presets - Recommendation Servicenow - Recommendation Tags - Recommendation Ignore List - AutoStopping Rules - AutoStopping Rules V2 - AutoStopping Load Balancers - AutoStopping Fixed Schedules - AutoStopping Alerts - Commitment Orchestrator Events APIs - name: Feature Flags tags: - API Keys - Feature Flags - Targets - Target Groups - Environment Perspectives - Anomalies - Proxy - Tags - name: SRM tags: - Monitored Services - SLOs dashboard - NG SLOs - SLOs - Downtime - Srm Notification - name: Internal Developer Portal - IDP tags: - Entities - Teams - CatalogCustomProperties - Scores - DataSource - KubernetesDataPoints - AggregationRules - AppConfig - PluginInfo - LayoutProxy - Kinds - LayoutsV3 - LayoutsV4 - name: Environment Management - IDP tags: - Environment - Infrastructure - Instance - name: Custom Dashboards tags: - aida - dashboards - downloads - embed - folders - name: Policy Management tags: - dashboard - examples - policies - evaluate - evaluations - policysets - system - name: Code tags: - repository - status_checks - pullreq - upload - webhook - resource - rules - labels - name: IaCM tags: - usage - approvals - costs - executions - module-registry - workspaces - settings - tf-standard-backend - variables - name: STO tags: - Exemptions - Issues - Scans - Products - Test Targets - Target Variants - name: SEI tags: - Collection categories - Collections - Contributors - DORA - name: Git Sync (deprecated) tags: - Git Branches - Git Full Sync - Git Sync Settings - Git Sync - Git Sync Errors - name: Error Models tags: - Error Response - Governance Metadata - name: Supply Chain Security tags: - integration - PipelineInfraConfig - SBOM - Integration Step Config - Delete Step Config - Delete Repositories - Pipeline Store Config - Evidence Vault [Beta] - name: Release Management tags: - Release Groups - Releases - Orchestration Processes - Orchestration Activities - Orchestration Executions - Conflicts - Freeze - Reports - Uploads - name: Resilience Testing tags: - Actions - Action Templates - Chaos Components - Chaos Hubs - ChaosGuard Conditions - ChaosGuard Rules - DR Tests - Experiments - Experiment Templates - Faults - Fault Templates - Chaos Infrastructure - Health - Network Maps - Onboarding - Probes - Probe Templates - Chaos Recommendations - Risks