Scale addon resources | Addons | Northflank API docs
v1
ApplicationAPI & CLI
Double column
API
CLI
JS Client

Addons /

Scale addon resources

Modifies the allocated resources for the given addon.

Required permission

Project > Addons > General > Update

Path parameters

    • projectId

      string required

      ID of the project

    • addonId

      string required

      ID of the addon

Request body

  • {object}

    • deploymentPlan

      string

      The ID of the deployment plan to use.

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

    • storage

      integer

      The size of the addon storage, in megabytes.

      min
      1

    • replicas

      integer

      The number of addon replicas to run.

Response body

  • {object}

    Response object.

    • data

      {object} required

      Result data.

    API
    CLI
    JS Client

    POST /v1/projects/{projectId}/addons/{addonId}/scale

    Example request

    Request body
    curl
    curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request POST \
  --data '{"deploymentPlan":"nf-compute-20","storage":1024,"replicas":1}' \
  https://api.northflank.com/v1/projects/{projectId}/addons/{addonId}/scale

    Example response

    200 OK

    The operation was performed successfully.

    JSON

    {
  "data": {}
}

    © 2024 Northflank Ltd. All rights reserved.

    northflank.comTermsPrivacyfeedback@northflank.com