COcoder
Agents

Get workspace agent by ID

Changed on
get/api/v2/workspaceagents/{workspaceagent}

Request

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

Path parameters

workspaceagentstring uuid required

Workspace agent ID

Response

OK

api_versionstring
architecturestring
connection_timeout_secondsinteger
created_atstring date-time
directorystring
disconnected_atstring date-time
display_appsCodersdkDisplayApp[]
environment_variablesobject
expanded_directorystring
first_connected_atstring date-time
idstring uuid
instance_idstring
last_connected_atstring date-time
latencyobject

DERPLatency is mapped by region name (e.g. "New York City", "Seattle").

lifecycle_state'created' | 'starting' | 'start_timeout' | 'start_error' | 'ready' | 'shutting_down' | 'shutdown_timeout' | 'shutdown_error' | 'off'
logs_lengthinteger
logs_overflowedboolean
namestring
operating_systemstring
parent_idstring uuid
ready_atstring date-time
resource_idstring uuid
started_atstring date-time
startup_script_behavior'blocking' | 'non-blocking'
status'connecting' | 'connected' | 'disconnected' | 'timeout'
subsystemsCodersdkAgentSubsystem[]
troubleshooting_urlstring
updated_atstring date-time
versionstring

Example response

{
  "health": {
    "reason": "agent has lost connection"
  }
}

Changes