Sign in
latestOpenAPI 3.0.32026-08-10152216352.3 KB

eea119b4113f

Workspaces

List Workspaces

Lists all Workspaces with Filtering and Sorting Options. Supports VCS Providers Integration.

post/workspaces/search

Query parameters

pageinteger
pageSizeinteger

Request body

projectionstring[]

Fields to include in the response

searchValuestring

Value to search for across searchable fields

Example request

{
  "filters": {
    "workspaceName": [
      "production-infra"
    ],
    "repositories": [
      "org/repo-name"
    ],
    "ciTool": [
      "github-actions"
    ],
    "status": [
      "plan_success"
    ],
    "vcsType": [
      "github"
    ],
    "poolId": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "$or": {
      "workspaceName": [
        "production-infra"
      ],
      "repositories": [
        "org/repo-name"
      ],
      "ciTool": [
        "github-actions"
      ],
      "status": [
        "plan_success"
      ],
      "vcsType": [
        "github"
      ],
      "poolId": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  }
}

Response

List of Workspaces Retrieved Successfully

idstring

Unique identifier

accountIdstring

Account ID

createdAtstring date-time

Timestamp when the workspace was created

updatedAtstring date-time

Timestamp when the workspace was last updated

workspaceIdstring

Workspace ID

workspaceNamestring

Name of the workspace

repostring

Repository name

repoUrlstring

Repository URL

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

lastRunStatus'pending' | 'running' | 'success' | 'failed' | 'canceled' | 'initializing' | 'queued' | 'planning' | 'planning_destroy' | 'applying' | 'destroying' | 'ready_for_apply' | 'ready_for_destroy' | 'destroyed' | 'destroy_plan_completed' | 'destroy_plan_failed' | 'destroy_failed' | 'discarded' | 'canceling_init' | 'canceling_plan' | 'canceling_planning_destroy' | 'canceling_apply' | 'canceling_destroy' | 'canceled_init' | 'canceled_plan' | 'canceled_planning_destroy' | 'canceled_apply' | 'canceled_destroy' | 'init_error' | 'plan_success' | 'plan_error' | 'apply_error' | 'apply_success' | 'blocked' | 'Acknowledged' | 'plan_no_changes' | 'apply_no_changes' | 'runner_failure'

The status of a workspace run

lastApplyTimestring date-time

Timestamp of the last apply

lastPlanTimestring date-time

Timestamp of the last plan

lastRunTimestring date-time

Timestamp of the last run

iacTypestring

Type of Infrastructure as Code

iacTypeVersionstring

Version of the IaC tool

labelsstring[]

Labels associated with the workspace

poolIdstring uuid

UUID of the runner pool associated with the workspace

runsCountinteger

Number of runs

isWorkflowManagedboolean

Whether the workflow is managed by the system

guardrailsstring[]

List of guardrails

oidcAuthenticationboolean nullable

OIDC authentication setting. If null, inherits from parent project.

isRemoteboolean

Whether this workspace uses the internal remote backend for state management

Example response

[
  {
    "id": "507f1f77bcf86cd799439011",
    "accountId": "507f1f77bcf86cd799439011",
    "workspaceId": "507f1f77bcf86cd799439012",
    "workspaceName": "production-infra",
    "repo": "org/repo-name",
    "repoUrl": "https://github.com/org/repo-name",
    "vcsType": "github",
    "runnerType": "github-actions",
    "lastRunStatus": "plan_success",
    "iacType": "terraform",
    "iacTypeVersion": "1.0.11",
    "backendSummary": {
      "backendType": "s3",
      "backendConfig": {
        "bucket": "terraform-state",
        "key": "prod/terraform.tfstate"
      },
      "iacStackId": "stack-123",
      "managedResourceCount": 42
    },
    "labels": [
      "prod",
      "terraform"
    ],
    "poolId": "123e4567-e89b-12d3-a456-426614174000",
    "runsCount": 5,
    "isWorkflowManaged": true,
    "guardrails": [
      "cost",
      "security"
    ]
  }
]