Agents

Watch for workspace agent metadata updates via WebSockets

Changed on
get/api/v2/workspaceagents/{workspaceagent}/watch-metadata-ws

Request

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

Path parameters

workspaceagentstring uuid required

Workspace agent ID

Response

OK

dataunknown
type'ping' | 'data' | 'error'

Changes