worker

list workers

Changed on
get/workers/list

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/workers/list
  • Auth: one of:
    • HTTP bearer
    • API key in cookie token

Query parameters

pageinteger

which page to return (start at 1, default 1)

per_pageinteger

number of items to return for a given page (default 30, max 100)

ping_sinceinteger

number of seconds the worker must have had a last ping more recent of (default to 300)

Response

a list of workers

workerstring required
worker_instancestring required
last_pingnumber
started_atstring date-time required
ipstring required
jobs_executedinteger required
custom_tagsstring[]
worker_groupstring required
wm_versionstring required
last_job_idstring
last_job_workspace_idstring
occupancy_ratenumber
occupancy_rate_15snumber
occupancy_rate_5mnumber
occupancy_rate_30mnumber
memorynumber
vcpusnumber
memory_usagenumber
wm_memory_usagenumber
job_isolationstring
native_modeboolean
drainingboolean

the worker received its shutdown signal and exits once its current job is done

Changes