GET
/
volumes
/
{volumeName}
Get volume
curl --request GET \
  --url https://api.blaxel.ai/v0/volumes/{volumeName} \
  --header 'Authorization: Bearer <token>'
{
  "events": [
    {
      "message": "<string>",
      "revision": "<string>",
      "status": "<string>",
      "time": "<string>",
      "type": "<string>"
    }
  ],
  "metadata": {
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "createdBy": "<string>",
    "updatedBy": "<string>",
    "displayName": "<string>",
    "labels": {},
    "name": "<string>",
    "plan": "<any>",
    "workspace": "<string>"
  },
  "spec": {
    "region": "<string>",
    "size": 123
  },
  "state": {
    "attachedTo": "<string>"
  },
  "status": "<string>",
  "terminatedAt": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
volumeName
string
required

Name of the volume

Response

200 - application/json

successful operation

Volume resource for persistent storage