v1
ApplicationAPI & CLI
API
CLI
JS Client

Volumes /

Backup volume

Initiates a backup for a given volume

Required permission

Project > Volumes > Backups > Create

Path parameters

    • projectId

      string required
      ID of the project

    • volumeId

      string required
      ID of the volume

Request body

  • {object}

    • name

      string required
      The name of the backup.
      min length
      3
      max length
      39
      pattern
      ^[a-zA-Z]((-|\s)?[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*)?$

    • description

      string
      The description for the backup.
      max length
      200
      pattern
      ^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$

Response body

  • {object}
    Response object.

    • data

      {object} required
      Result data.

      • id

        string required
        Identifier for the backup

      • name

        string required

      • description

        string

      • status

        string required

      • spec

        {object}

      • source

        {object}

        • type

          string

        • sourceObject

          {object}

          • id

            string required

          • spec

            {object}

      • createdAt

        string
        time of creation

      • updatedAt

        string
        time of update
API
CLI
JS Client

POST /v1/projects/{projectId}/volumes/{volumeId}/backups

Example request

Request body
curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request POST \
  --data '{"name":"Example Backup","description":"Example backup description"}' \
  https://api.northflank.com/v1/projects/{projectId}/volumes/{volumeId}/backups

Example response

200 OK

Details about the created volume backup.

JSON

{
  "data": {
    "id": "example-backup"
  }
}

© 2026 Northflank Ltd. All rights reserved.

northflank.comTermsPrivacyfeedback@northflank.com