workloads

Get workload status

Changed on Jun 25, 2026

Get the current status of a specific workload

get/api/v1beta/workloads/{name}/status

Request

The document declares no server URL.
Auth
none declared
TypeScript
https://skmtc.dev/stacklok/apis/toolhive-api/docs/api/v1beta/workloads/:name/status/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

namestring required

Workload name

Response

OK

status'running' | 'stopped' | 'error' | 'starting' | 'stopping' | 'unhealthy' | 'removing' | 'unknown' | 'unauthenticated' | 'auth_retrying' | 'policy_stopped'

Current status of the workload

Changes

Jun 25, 20263264ef650b69 Revision changes
- warning
  added the new auth_retrying enum value to the response property for the response status
- warning
  added the new auth_retrying enum value to the response property for the response status
- warning
  added the new auth_retrying enum value to the response property for the response status
Apr 21, 2026ead8d06eaeaa Revision changes
- warning
  added the new policy_stopped enum value to the response property for the response status
- warning
  added the new policy_stopped enum value to the response property for the response status
- warning
  added the new policy_stopped enum value to the response property for the response status

Operation history (3 revisions)