Project / Rollout Strategies /

Roll back service rollout

Ends the active gradual rollout and redeploys the service from a previous deployment. Use the list service deployments endpoint to find the deployment to roll back to.

Required permission

Project > Services > General > Update

Path parameters

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

Request body

{object}
The deployment to roll back to.

deployment
string required
Identifier of the deployment to roll back to, as returned by the list service deployments endpoint. Must be a deployment of this service.
min length
24
max length
24

Response body

{object}
Response object.

data
{object} required
Result data.

id
string required
Identifier of the new deployment created by the rollback.

API

CLI

JS Client

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

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

Example request

Request body

curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request POST \
  --data '{"deployment":"6560a1b2c3d4e5f6a7b8c9d0"}' \
  https://api.northflank.com/v1/projects/{projectId}/services/{serviceId}/rollout/rollback

Example response

200 OK

The deployment created by the rollback.

JSON

{
  "data": {
    "id": "6560a1b2c3d4e5f6a7b8c9d0"
  }
}