Project / Rollout Strategies /

Promote service rollout

Promotes the canary deployment of the active gradual rollout to stable, routing all traffic to it. This is idempotent: promoting an already promoted rollout succeeds without changing anything.

Required permission

Project > Services > General > Update

Path parameters

projectId
string required
ID of the project
serviceId
string required
ID of the service

Response body

{object}
Response object.

data
{object} required
Result data.

API

CLI

JS Client

POST /v1/projects/{projectId}/services/{serviceId}/rollout/promote

POST /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/rollout/promote

Example response

200 OK

The operation was performed successfully.

JSON

{
  "data": {}
}

Example response

404 Not Found

The service does not have an active gradual rollout.

Example response

409 Conflict

The canary deployment has not finished deploying successfully.