Organization API: Organization deployments: Canary

Part of Organization deployments.

GET /api/v1/orgs/{org_slug}/deployments/{deployment_uuid}/canary

The production release that takes a share of the traffic beside the current one (null without one): its share, its status, and whether it serves yet (serving; until it does the current release takes everything). current is the current release.

PUT /api/v1/orgs/{org_slug}/deployments/{deployment_uuid}/canary

Give a production release newer than the current one, on its way or ready, traffic_percent (1 to 99) of the traffic; without release, change the share of the release that holds one. A visitor stays on the release they got for an hour. 404 for a release that is not the deployment's, or no canary; 409 as detail.error says (no_current, release_current, release_preview, release_not_live, release_older, canary_exists, app_not_active).

application/json (required)

POST /api/v1/orgs/{org_slug}/deployments/{deployment_uuid}/canary/abort

Take the canary's share away and end it: the current release takes all the traffic, and the canary's instances leave after the drain window. release as for promote. 404 without a canary.

application/json

POST /api/v1/orgs/{org_slug}/deployments/{deployment_uuid}/canary/promote

Make the canary the current release: it takes all the traffic, and the release it shared with is superseded and leaves service after the drain window. release guards against acting on a canary that changed since it was read (409 canary_changed). 404 without a canary; 409 canary_not_ready while it is still deploying.

application/json