REST API Reference

Authentication

Authorization: Bearer <your-api-key>

API keys are created in the dashboard under Settings > API Keys.

Base URL

https://api.kubestead.com/v1

Endpoints

GET /v1/rollouts

List all Rollout resources across your clusters.

curl -H "Authorization: Bearer <key>" \
  https://api.kubestead.com/v1/rollouts

{
  "rollouts": [
    {
      "id": "payments-service",
      "namespace": "production",
      "status": "Progressing",
      "currentWeight": 12,
      "analysisResult": "Successful"
    }
  ]
}

GET /v1/rollouts/{id}

Get detailed status for a specific Rollout.

POST /v1/rollouts/{id}/pause

Pause an active rollout at its current traffic weight.

curl -X POST -H "Authorization: Bearer <key>" \
  https://api.kubestead.com/v1/rollouts/payments-service/pause

POST /v1/rollouts/{id}/resume

Resume a paused rollout.

POST /v1/rollouts/{id}/rollback

Trigger an immediate rollback, bypassing the automated policy.

GET /v1/rollouts/{id}/history

Retrieve the AnalysisRun history for a Rollout, including metric snapshots.

Rate Limits

Tier	Requests / min
Starter	60
Team	300
Scale	Unlimited