COcoder
Agents

Patch workspace agent app status

Changed on
patch/api/v2/workspaceagents/me/app-status

Request

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

Request body

app_slugstring
iconstring

Deprecated: this field is unused and will be removed in a future version.

messagestring
needs_user_attentionboolean

Deprecated: this field is unused and will be removed in a future version.

state'working' | 'idle' | 'complete' | 'failure'
uristring

Only http, https, and file URIs are kept; others are dropped.

Response

OK

detailstring

Detail is a debug message that provides further insight into why the action failed. This information can be technical and a regular golang err.Error() text.

  • "database: too many open connections"
  • "stat: too many open files"
messagestring

Message is an actionable message that depicts actions the request took. These messages should be fully formed sentences with proper punctuation. Examples:

  • "A user has been created."
  • "Failed to create a user."

Changes