Skip to content
New Signal-based gating for canary steps is live in v2.14 Read the changelog →

Reference

HTTP API

Authentication, the promotion endpoint, and webhook payloads.

Authentication

All requests take a bearer token.

Authorization: Bearer <token>

Create a promotion

POST /v1/promotions
{
  "service": "api-gateway",
  "from": "staging",
  "to": "production",
  "reason": "release 2411"
}

Returns 202 Accepted with a promotion id. Poll /v1/promotions/{id} or subscribe to the promotion.settled webhook.

Rate limits

600 requests per minute per token. The limit is returned in X-RateLimit-Remaining.