v1
ApplicationAPI & CLI
API
CLI
JS Client

Volumes /

Get volume backups

Get list of backups associated with a volume

Required permission

Project > Volumes > Backups > Read

Path parameters

    • projectId

      string required
      ID of the project

    • volumeId

      string required
      ID of the volume

Query parameters

    • per_page

      integer
      The number of results to display per request. Maximum of 100 results per page.

    • page

      integer
      The page number to access.

    • cursor

      string
      The cursor returned from the previous page of results, used to request the next page.

Response body

  • {object}
    Response object.

    • data

      [array] required
      Result data.
      • {object}

        • 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

    • pagination

      {object} required
      Data about the endpoint pagination.

      • hasNextPage

        boolean required
        Is there another page of results available?

      • cursor

        string
        The cursor to access the next page of results.

      • count

        number required
        The number of results returned by this request.
API
CLI
JS Client

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

Example response

200 OK

The list of volume backups.

JSON

{
  "data": [
    {
      "id": "example-backup"
    }
  ],
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}

© 2026 Northflank Ltd. All rights reserved.

northflank.comTermsPrivacyfeedback@northflank.com