Create persistent volume

Creates a new persistent storage volume that can be attached to sandboxes. Volumes must be created in a specific region and can only attach to sandboxes in the same region.

POST /volumes

Create persistent volume

cURL

curl --request POST \
  --url https://api.blaxel.ai/v0/volumes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {
    "name": "my-resource",
    "displayName": "My Resource",
    "externalId": "my-session-123",
    "labels": {}
  },
  "spec": {
    "region": "us-pdx-1",
    "size": 1024,
    "template": "mytemplate:latest"
  }
}
'

import requests

url = "https://api.blaxel.ai/v0/volumes"

payload = {
    "metadata": {
        "name": "my-resource",
        "displayName": "My Resource",
        "externalId": "my-session-123",
        "labels": {}
    },
    "spec": {
        "region": "us-pdx-1",
        "size": 1024,
        "template": "mytemplate:latest"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    metadata: {
      name: 'my-resource',
      displayName: 'My Resource',
      externalId: 'my-session-123',
      labels: {}
    },
    spec: {region: 'us-pdx-1', size: 1024, template: 'mytemplate:latest'}
  })
};

fetch('https://api.blaxel.ai/v0/volumes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.blaxel.ai/v0/volumes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'metadata' => [
        'name' => 'my-resource',
        'displayName' => 'My Resource',
        'externalId' => 'my-session-123',
        'labels' => [
                
        ]
    ],
    'spec' => [
        'region' => 'us-pdx-1',
        'size' => 1024,
        'template' => 'mytemplate:latest'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.blaxel.ai/v0/volumes"

	payload := strings.NewReader("{\n  \"metadata\": {\n    \"name\": \"my-resource\",\n    \"displayName\": \"My Resource\",\n    \"externalId\": \"my-session-123\",\n    \"labels\": {}\n  },\n  \"spec\": {\n    \"region\": \"us-pdx-1\",\n    \"size\": 1024,\n    \"template\": \"mytemplate:latest\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.blaxel.ai/v0/volumes")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"metadata\": {\n    \"name\": \"my-resource\",\n    \"displayName\": \"My Resource\",\n    \"externalId\": \"my-session-123\",\n    \"labels\": {}\n  },\n  \"spec\": {\n    \"region\": \"us-pdx-1\",\n    \"size\": 1024,\n    \"template\": \"mytemplate:latest\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.blaxel.ai/v0/volumes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"metadata\": {\n    \"name\": \"my-resource\",\n    \"displayName\": \"My Resource\",\n    \"externalId\": \"my-session-123\",\n    \"labels\": {}\n  },\n  \"spec\": {\n    \"region\": \"us-pdx-1\",\n    \"size\": 1024,\n    \"template\": \"mytemplate:latest\"\n  }\n}"

response = http.request(request)
puts response.read_body

200

{
  "metadata": {
    "name": "my-resource",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "createdBy": "<string>",
    "updatedBy": "<string>",
    "displayName": "My Resource",
    "externalId": "my-session-123",
    "labels": {},
    "plan": "<string>",
    "url": "<string>",
    "workspace": "<string>"
  },
  "spec": {
    "infrastructureId": "<string>",
    "region": "us-pdx-1",
    "size": 1024,
    "template": "mytemplate:latest"
  },
  "events": [
    {
      "canaryRevision": "<string>",
      "message": "Deployment successful",
      "revision": "rev-abc123",
      "status": "DEPLOYED",
      "time": "2025-01-15T10:30:00Z",
      "type": "deployment"
    }
  ],
  "state": {
    "attachedTo": "sandbox:my-sandbox"
  },
  "status": "<string>",
  "terminatedAt": "<string>"
}

{
  "error": "Resource already exists",
  "code": 409,
  "message": "Invalid request body"
}

{
  "error": "Resource already exists",
  "code": 409,
  "message": "Invalid request body"
}

{
  "error": "Resource already exists",
  "code": 409,
  "message": "Invalid request body"
}

{
  "error": "Resource already exists",
  "code": 409,
  "message": "Invalid request body"
}

{
  "error": "Resource already exists",
  "code": 409,
  "message": "Invalid request body"
}

Authorizations

OAuth2ApiKeyAuth

Authorization · string · header · required

OAuth2 authentication with JWT tokens

Body

application/json

Persistent storage volume that can be attached to sandboxes for durable file storage across sessions. Volumes survive sandbox deletion and can be reattached to new sandboxes.

metadata · object · required

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

Show child attributes

spec · object · required

Immutable volume configuration set at creation time (size and region cannot be changed after creation)

Show child attributes

Response

200

application/json

successful operation

Persistent storage volume that can be attached to sandboxes for durable file storage across sessions. Volumes survive sandbox deletion and can be reattached to new sandboxes.

metadata · object · required

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

Show child attributes

spec · object · required

Immutable volume configuration set at creation time (size and region cannot be changed after creation)

Show child attributes

events · object[] · read-only

Events happening on a resource deployed on Blaxel

Show child attributes

state · object · read-only

Current runtime state of the volume including attachment status

Show child attributes

status · string · read-only

Volume status computed from events

terminatedAt · string · read-only

Timestamp when the volume was marked for termination