COcoder
Builds

Get provisioner state for workspace build

Changed on
get/api/v2/workspacebuilds/{workspacebuild}/state

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v2/workspacebuilds/{workspacebuild}/state
  • Auth
    API key in header Coder-Session-Token

Path parameters

workspacebuildstring required

Workspace build ID

Response

OK

build_numberinteger
created_atstring date-time
daily_costinteger
deadlinestring date-time
has_external_agentboolean
idstring uuid
initiator_idstring uuid
initiator_namestring
max_deadlinestring date-time
reason'initiator' | 'autostart' | 'autostop' | 'dormancy' | 'dashboard' | 'cli' | 'ssh_connection' | 'vscode_connection' | 'jetbrains_connection'
status'pending' | 'starting' | 'running' | 'stopping' | 'stopped' | 'failed' | 'canceling' | 'canceled' | 'deleting' | 'deleted'
template_version_idstring uuid
template_version_namestring
template_version_preset_idstring uuid
transition'start' | 'stop' | 'delete'
updated_atstring date-time
workspace_idstring uuid
workspace_namestring
workspace_owner_avatar_urlstring
workspace_owner_idstring uuid
workspace_owner_namestring

WorkspaceOwnerName is the username of the owner of the workspace.

Example response

{
  "resources": [
    {
      "agents": [
        {
          "health": {
            "reason": "agent has lost connection"
          }
        }
      ]
    }
  ]
}

Changes