Sign in
Agent Jobs

List agent jobs for a workspace

Changed on
get/workspaces/{workspaceSlug}/agents/jobs

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /workspaces/{workspaceSlug}/agents/jobs
  • Auth: HTTP bearer

Path parameters

workspaceSlugstring required

Workspace slug

Query parameters

status'QUEUED' | 'RUNNING' | 'COMPLETED' | 'FAILED' | 'TIMED_OUT' | 'CANCELLED'

Filter by job status

pageinteger
sizeinteger

Response

Paginated job list

emptyboolean
firstboolean
lastboolean
numberinteger
numberOfElementsinteger
sizeinteger
totalElementsinteger
totalPagesinteger

Changes

  • 7e212c94057dRevision changes
    • info

      added the optional property // to the response with the status

  • 9662502b2cc4Revision changes
    • breaking

      for the path request parameter workspaceSlug, the minLength was increased from 0 to 3

    • warning

      for the path request parameter workspaceSlug, the maxLength was set to 51

    • warning

      changed the pattern of the path request parameter workspaceSlug from ^[a-z0-9][a-z0-9-]{2,50}$ to ^(?!.*--)[a-z0-9][a-z0-9-]{1,49}[a-z0-9]$