v1
ApplicationAPI & CLI
Double column
API
CLI
JS Client

Jobs /

Scale job

Modifies the scaling settings for the given job.

Required permission

Project > Jobs > Deployment > Scale Job

Path parameters

    • projectId

      string required
      ID of the project

    • jobId

      string required
      ID of the job

Request body

  • {object}

    • deploymentPlan

      string
      ID of the deployment plan to switch to.
      min length
      3
      max length
      100
      pattern
      ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$

    • storage

      {object}

      • ephemeralStorage

        {object}

        • storageSize

          integer
          Ephemeral storage per container in MB
          min
          1024

      • shmSize

        integer
        Configures the amount of available memory-backed disk space available to /dev/shm
        min
        64

Response body

  • {object}
    Response object.

    • data

      {object} required
      Result data.
    API
    CLI
    JS Client

    POST /v1/projects/{projectId}/jobs/{jobId}/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":{"ephemeralStorage":{"storageSize":1024}}}' \
  https://api.northflank.com/v1/projects/{projectId}/jobs/{jobId}/scale

    Example response

    200 OK

    The operation was performed successfully.

    JSON

    {
  "data": {}
}

    © 2025 Northflank Ltd. All rights reserved.

    northflank.comTermsPrivacyfeedback@northflank.com