Volumes /
Get volume
Retrieve a volume
Required permission
Project > Volumes > General > Read
Path parameters
projectId
string requiredID of the projectvolumeId
string requiredID of the volume
Response body
- {object}Response object.
data
{object} requiredResult data.id
string requiredIdentifier for the volumename
string requiredVolume namespec
{object} requiredExample storage schemaattachedObjects
[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 ofservice, jobstatus
string requiredStatus the volume is in on the clustercreatedAt
string requiredThe timestamp the volume was created atupdatedAt
string requiredThe timestamp the volume was last updated at
API
CLI
JS Client
GET /v1/projects/{projectId}/volumes/{volumeId}
Example response
200 OK
Details about the specified Volume.
JSON
{
"data": {
"id": "example-volume",
"name": "Example Volume",
"spec": {
"storageClassName": "ssd",
"storageSize": 6144
},
"attachedObjects": [
{
"id": "example-service",
"type": "service"
}
],
"status": "BOUND",
"createdAt": "2021-01-01 12:00:00.000Z",
"updatedAt": "2021-01-01 12:00:00.000Z"
}
}