v1
ApplicationAPI & CLI
Double column
API
CLI
JS client

Services /

Resume service

Resumes the given service. Optionally takes instances to resume with a given number of instances.

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

Response body

  • {object}

    • success

      boolean required

      Boolean indicating the performed action was successful.

API
CLI
JS client

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

Example request

request body

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

Example response

200 OK

The operation was performed successfully.

JSON

{
  "success": true
}

Example response

409 Conflict

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

© 2021 Northflank Ltd. All rights reserved.

northflank.comTermsPrivacyfeedback@northflank.com