v1
Double column
API
CLI
JS Client

Services /

Scale service

Modifies the scaling settings for the given service.

Required permission

Project > Services > Deployment > Scale Service

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

    • deploymentPlan

      string

      ID of the deployment plan to switch to.

      pattern
      ^[A-Za-z0-9-]+$

Response body

  • {object}

    Response object.

    • data

      {object} required

      Result data.

    API
    CLI
    JS Client

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

    Example request

    Request body

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

    Example response

    200 OK

    The operation was performed successfully.

    JSON

    {
      "data": {}
    }

    © 2022 Northflank Ltd. All rights reserved.