Volumes /
List volumes
Required permission
Project > Volumes > General > Read
Path parameters
projectId
string requiredID of the project
Response body
- {object}
Response object.
data
[array] requiredResult data.
- {object}
A volume object
id
string requiredIdentifier for the volume
name
string requiredVolume name
spec
(multiple options: oneOf) requiredInformation about the desired size and type of the volume. Storage class is only configurable with the relevant feature flag enabled for your account.
attachedObjects
[array]List of objects this volume is attached to.
- {object}
The object to attach this volume to.
id
string requiredThe id of object to attach this volume to.
pattern^[A-Za-z0-9-]+$type
string requiredThe type of the object to attach this volume to.
one ofservicestatus
string requiredStatus the volume is in on the cluster
createdAt
string requiredThe timestamp the volume was created at
updatedAt
string requiredThe timestamp the volume was last updated at
pagination
{object} requiredData about the endpoint pagination.
hasNextPage
boolean requiredIs there another page of results available?
cursor
stringThe cursor to access the next page of results.
count
number requiredThe number of results returned by this request.
GET /v1/projects/{projectId}/volumes
Example response
200 OK
JSON
{
"data": [
{
"id": "example-volume",
"name": "Example Volume",
"tags": [
"my-tag"
],
"spec": {
"storageClassName": "ssd",
"storageSize": 4096
},
"attachedObjects": [
{
"id": "example-service",
"type": "service"
}
],
"status": "BOUND",
"createdAt": "2021-01-01 12:00:00.000Z",
"updatedAt": "2021-01-01 12:00:00.000Z"
}
],
"pagination": {
"hasNextPage": false,
"count": 1
}
}