Sign in
latestOpenAPI 3.0.32026-08-10152216352.3 KB

eea119b4113f

Self-Hosted Runners

Update a workspace (self-hosted)

patch/self-hosted/{accountId}/workspaces/{workspaceId}

Path parameters

accountIdstring required

Unique identifier of the account

workspaceIdstring required

Unique identifier of the workspace

Request body

descriptionstring
labelsstring[]
cronExecutionPatternstring
repositoryUrlstring
runsCountinteger
isWorkflowManagedboolean
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'
lastApplyTimestring date-time
lastPlanTimestring date-time
lastDestroyTimestring date-time
lastRunTimestring date-time
backendsobject

Map of environment to backend summary

poolIdstring

ID of the runner pool to assign to this workspace

oidcAuthenticationboolean nullable

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

Example request

{
  "backendSummary": {
    "type": "s3",
    "config": {
      "bucket": "terraform-state",
      "key": "prod/terraform.tfstate"
    },
    "resources": 42
  }
}

Response

Workspace updated successfully