Project / Services /

Resume service

Resumes the given service. Optionally takes several arguments to override resumed settings.

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}

instances
integer
The number of instances to scale the service to upon resuming
disabledCI
boolean
Whether CI should be disabled
disabledCD
boolean
Whether CD should be disabled
enableAutoscaling
boolean
Whether to restore autoscaling on resume. Defaults to the autoscaling state captured when the service was paused. Set to false to resume without autoscaling; it cannot enable autoscaling that was not active before the pause

Response body

{object}
Response object.

data
{object} required
Result data.

API

CLI

JS Client

POST /v1/projects/{projectId}/services/{serviceId}/resume

POST /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/resume

Example request

Request body

curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request POST \
  --data '{"instances":1,"disabledCI":false,"disabledCD":false,"enableAutoscaling":true}' \
  https://api.northflank.com/v1/projects/{projectId}/services/{serviceId}/resume

Example response

200 OK

The operation was performed successfully.

JSON

{
  "data": {}
}

Example response

409 Conflict

The service could not be resumed as it is not paused.