v1
ApplicationAPI & CLI
API
CLI
JS Client

Volumes /

Get volume backup details

Get details for a specific volume backup

Required permission

Project > Volumes > Backups > Read

Path parameters

    • projectId

      string required
      ID of the project

    • volumeId

      string required
      ID of the volume

    • backupId

      string required
      ID of the backup

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

GET /v1/projects/{projectId}/volumes/{volumeId}/backups/{backupId}

Example response

200 OK

Details about the specified volume backup.

JSON

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

© 2026 Northflank Ltd. All rights reserved.

northflank.comTermsPrivacyfeedback@northflank.com