POST
/
v1
/
data
Create a new data volume
curl --request POST \
  --url https://api.example.com/v1/data \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "from_data": "<string>",
  "from_snapshot": "<string>",
  "project": "<string>"
}
'
import requests

url = "https://api.example.com/v1/data"

payload = {
"name": "<string>",
"from_data": "<string>",
"from_snapshot": "<string>",
"project": "<string>"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
from_data: '<string>',
from_snapshot: '<string>',
project: '<string>'
})
};

fetch('https://api.example.com/v1/data', 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.example.com/v1/data",
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([
'name' => '<string>',
'from_data' => '<string>',
'from_snapshot' => '<string>',
'project' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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.example.com/v1/data"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"from_data\": \"<string>\",\n \"from_snapshot\": \"<string>\",\n \"project\": \"<string>\"\n}")

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

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.example.com/v1/data")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"from_data\": \"<string>\",\n \"from_snapshot\": \"<string>\",\n \"project\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/data")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"from_data\": \"<string>\",\n \"from_snapshot\": \"<string>\",\n \"project\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "created_at": "<string>",
  "name": "<string>",
  "ownership": {
    "kind": "persistent"
  },
  "size_bytes": 1,
  "project": "<string>"
}

Body

application/json
name
string
required

Safe data volume name. Names must be lowercase a-z0-9-, 1-63 characters, start and end alphanumeric, and not contain --.

from_data
string | null

Source data volume name when creating from an existing snapshot.

from_snapshot
string | null

Source snapshot name when creating from an existing data snapshot.

project
string | null

Optional display label; carries no scope or behavior.

Response

Data volume created

created_at
string
required
name
string
required
ownership
object
required

Who owns a data volume, as a closed sum type. Persistent volumes outlive every box; BoxOwned volumes are reaped with their owning box (which stays project-scoped, so the variant carries the owner's project + box). Whether a volume is deleted with its owner is computed from the variant, never stored.

size_bytes
integer<int64>
required
Required range: x >= 0
project
string | null

Optional display label; volumes are global and carry no project scope.