Project / Volumes /

List volumes

Gets a list of volumes belonging to the project

Required permission

Project > Volumes > General > Read

Path parameters

projectId
string required
ID of the project

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}
A volume object

id
string required
Identifier for the volume
name
string required
Volume name
tags
[array] required
An array of previously defined tags to help identify and group the resource.

string
min length
3
max length
100
pattern
^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$

spec
{object} required
Example storage schema
attachedObjects
[array]
List of objects this volume is attached to.

{object}
The object to attach this volume to.

id
string required
The id of object to attach this volume to.
pattern
^[A-Za-z0-9-]+$
type
string required
The type of the object to attach this volume to.
one of
service, job

backupSchedules
[array]

{object}

scheduling
{object} required
Schedule for the backup.

interval
string required
The interval between backups. Each addon can only have one backup schedule of each interval for each backup type.
one of
hourly, daily, weekly
minute
[array] required
An array of minutes when the backup should be performed.

integer
A minute when the backup should be performed.
min
0
max
59

hour
[array]
An array of hours in 24 hour format when the backup should be performed. At these hours, a backup will be performed at each of the minutes provided in the `minute` field. Required for `daily` and `weekly` intervals and unavailable for `hourly` intervals.

integer
An hour when the backup should be performed, in 24 hour format.
min
0
max
23

day
[array]
An array of days of the week when the backup should be performed, where `0` represents Monday and `6` represents Sunday. On these days, a backup will be performed at each of the minutes provided in the `minute` field whenever it is an hour from the `hour` field. Required for `weekly` intervals and unavailable for `hourly` and `daily` intervals.

integer
A day of the week when the backup should be performed, where `0` represents Monday and `6` represents Sunday.
min
0
max
6

retentionTime
integer required
The time the backup is retained for, in days.
min
1

status
string required
Status the volume is in on the cluster
createdAt
string required
The timestamp the volume was created at
updatedAt
string required
The timestamp the volume was last updated at

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

GET /v1/teams/{teamId}/projects/{projectId}/volumes

Example response

200 OK

The list of volumes.

JSON

{
  "data": [
    {
      "id": "example-volume",
      "name": "Example Volume",
      "spec": {
        "storageClassName": "nvme",
        "storageSize": 6144
      },
      "attachedObjects": [
        {
          "id": "example-service",
          "type": "service"
        }
      ],
      "backupSchedules": [
        {
          "scheduling": {
            "interval": "weekly",
            "minute": [
              30
            ],
            "hour": [
              18
            ],
            "day": [
              4
            ]
          },
          "retentionTime": 7
        }
      ],
      "status": "BOUND",
      "createdAt": "2021-01-01 12:00:00.000Z",
      "updatedAt": "2021-01-01 12:00:00.000Z"
    }
  ],
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}