Skip to main content

List deployments

GET 
/deployments

Returns deployments showing how job versions are rolled out to nodes.

What are Deployments?​

Deployments track how job changes are rolled out to nodes. They are created automatically when:

  • A new job is created (type: create)
  • A job spec is updated (type: update)
  • A job is restarted (type: restart)
  • A job is rolled back to a previous version (type: rollback)

Each deployment tracks:

  • FromVersion and ToVersion (version transition)
  • Deployment state (pending, in_progress, completed, failed, etc.)
  • Deployment strategy (immediate, rolling, canary)
  • Progress metrics (nodes updated, health status)

Filtering​

  • job_id: Show deployments for a specific job
  • states: Filter by deployment state
  • types: Filter by deployment type (create, update, rollback, etc.)
  • namespace: Filter by namespace

Common Workflows​

  • View deployment history: GET /jobs/{id}/deployments
  • Find active deployments: ?states=pending,in_progress
  • Track rollouts: Check deployment progress and health

Request​

Responses​

OK