Skip to main content
GET
/
volume_templates
/
{volumeTemplateName}
Get volume template
curl --request GET \
  --url https://api.blaxel.ai/v0/volume_templates/{volumeTemplateName} \
  --header 'Authorization: Bearer <token>'
{
  "metadata": {
    "name": "my-resource",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "createdBy": "<string>",
    "updatedBy": "<string>",
    "displayName": "My Resource",
    "labels": {},
    "plan": "<string>",
    "url": "<string>",
    "workspace": "<string>"
  },
  "spec": {
    "defaultSize": 123,
    "description": "<string>"
  },
  "state": {
    "lastVersionUploadedAt": "<string>",
    "latestVersion": "<string>",
    "status": "created",
    "versionCount": 123
  },
  "versions": [
    {
      "bucket": "<string>",
      "contentSize": 123,
      "name": "<string>",
      "region": "<string>",
      "status": "CREATED",
      "templateName": "<string>",
      "versionId": "<string>",
      "workspace": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

OAuth2 authentication with JWT tokens

Path Parameters

volumeTemplateName
string
required

Name of the volume template

Response

200 - application/json

successful operation

Volume template for creating pre-configured volumes

metadata
object
required

Common metadata fields shared by all Blaxel resources including name, labels, timestamps, and ownership information

spec
object
required

Volume template specification

state
object

Volume template state

versions
object[]

List of versions for this template