Sign in
latestOpenAPI 3.0.32026-08-10152216352.3 KB

eea119b4113f

Workspaces

Get Workspace Tasks for Environment

Gets all tasks for a specific environment in a workspace run

get/workspaces/{workspaceId}/runs/{runId}/tasks/environment/{environmentName}

Response

Workspace tasks for environment retrieved successfully

idstring

Unique identifier

accountIdstring

Unique identifier of the associated account

createdAtstring date-time

Timestamp when the entity was created

updatedAtstring date-time

Timestamp when the entity was last updated

contentKeysobject

Keys for accessing content related to subtasks

statusstring

Status of the task run

resultStatusstring

Result status of the task

type'post-plan' | 'post-apply'

The type of task in the workflow

vcsType'github' | 'gitlab' | 'bitbucket' | 'codecommit' | 'azuredevops'

The type of version control system

runnerType'github-actions' | 'gitlab-pipelines' | 'bitbucket-pipelines' | 'azure-pipelines' | 'jenkins' | 'semaphore' | 'atlantis' | 'env0' | 'firefly' | 'unrecognized'

The type of CI/CD runner or pipeline system

Example response

[
  {
    "id": "507f1f77bcf86cd799439011",
    "accountId": "507f1f77bcf86cd799439011",
    "status": "completed",
    "resultStatus": "success",
    "type": "post-plan",
    "guardrailsSummary": {
      "total": 10,
      "passed": 8,
      "failed": 2,
      "violations": [
        {
          "id": "v1",
          "severity": "high",
          "message": "Resource does not have required tags"
        }
      ]
    },
    "backendSummary": {
      "type": "s3",
      "config": {
        "bucket": "terraform-state",
        "key": "prod/terraform.tfstate"
      },
      "resources": 42
    },
    "changedFilesCodeSummary": {
      "total": 5,
      "added": 2,
      "modified": 3,
      "files": [
        {
          "path": "main.tf",
          "type": "modified"
        }
      ]
    },
    "vcsType": "github",
    "runnerType": "github-actions"
  }
]