Create or update volume template

Creates or updates a volume template.

PUT /volume_templates/{volumeTemplateName}

Create or update volume template

cURL

curl --request PUT \
  --url https://api.blaxel.ai/v0/volume_templates/{volumeTemplateName} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {
    "name": "my-resource",
    "displayName": "My Resource",
    "labels": {}
  },
  "spec": {
    "defaultSize": 123,
    "description": "<string>"
  },
  "state": {},
  "versions": [
    {
      "name": "<string>",
      "templateName": "<string>"
    }
  ]
}
'

200

{
  "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>",
    "versionCount": 123
  },
  "versions": [
    {
      "bucket": "<string>",
      "contentSize": 123,
      "name": "<string>",
      "region": "<string>",
      "templateName": "<string>",
      "versionId": "<string>",
      "workspace": "<string>"
    }
  ]
}

Authorizations

OAuth2ApiKeyAuth

Authorization · string · header · required

OAuth2 authentication with JWT tokens

Path Parameters

volumeTemplateName · string · required

Name of the volume template

Query Parameters

upload · boolean

If true, returns a presigned URL for uploading the template content

version · string

Version name for the template version being created

Body

application/json

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

Show child attributes

spec · object · required

Volume template specification

Show child attributes

state · object

Volume template state

versions · object[]

List of versions for this template

Show child attributes

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

Show child attributes

spec · object · required

Volume template specification

Show child attributes

state · object

Volume template state

Show child attributes

versions · object[]

List of versions for this template

Show child attributes