curl --request POST \
--url https://compute.{region}.basaltic.sh/v1/instances/{instance_id}/volumes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"volume": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"device": "vdb",
"mount_path": "/data",
"fstype": "ext4"
}
'import requests
url = "https://compute.{region}.basaltic.sh/v1/instances/{instance_id}/volumes"
payload = {
"volume": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"device": "vdb",
"mount_path": "/data",
"fstype": "ext4"
}
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({
volume: '7c9e6679-7425-40de-944b-e07fc1f90ae7',
device: 'vdb',
mount_path: '/data',
fstype: 'ext4'
})
};
fetch('https://compute.{region}.basaltic.sh/v1/instances/{instance_id}/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://compute.{region}.basaltic.sh/v1/instances/{instance_id}/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([
'volume' => '7c9e6679-7425-40de-944b-e07fc1f90ae7',
'device' => 'vdb',
'mount_path' => '/data',
'fstype' => 'ext4'
]),
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://compute.{region}.basaltic.sh/v1/instances/{instance_id}/volumes"
payload := strings.NewReader("{\n \"volume\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n \"device\": \"vdb\",\n \"mount_path\": \"/data\",\n \"fstype\": \"ext4\"\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://compute.{region}.basaltic.sh/v1/instances/{instance_id}/volumes")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"volume\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n \"device\": \"vdb\",\n \"mount_path\": \"/data\",\n \"fstype\": \"ext4\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://compute.{region}.basaltic.sh/v1/instances/{instance_id}/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 \"volume\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n \"device\": \"vdb\",\n \"mount_path\": \"/data\",\n \"fstype\": \"ext4\"\n}"
response = http.request(request)
puts response.read_body{
"volume": {
"id": "5f8d2c1a-9b3e-4d7a-8c6f-1e2a3b4c5d6e",
"crn": "crn:storage:sa-saopaulo-1:my-account:volume/data-volume-01",
"name": "data-vol-01",
"tags": {
"environment": "production",
"team": "backend"
},
"volume_type": "ssd",
"size_gb": 100,
"performance": {
"requested": {
"iops": 3000,
"bytes_per_sec": 131072000,
"burst_iops": 0,
"burst_bytes_per_sec": 0,
"burst_seconds": 0
},
"applied": {
"iops": 3000,
"bytes_per_sec": 131072000,
"burst_iops": 0,
"burst_bytes_per_sec": 0,
"burst_seconds": 0
}
},
"included_io_limits": {
"iops": 3000,
"bytes_per_sec": 131072000,
"burst_iops": 0,
"burst_bytes_per_sec": 0,
"burst_seconds": 0
},
"status": "available",
"bootable": false,
"faults": [
{
"code": "BACKUP_FAILED",
"severity": "error",
"message": "Backup upload failed.",
"details": {},
"first_at": "2023-11-07T05:31:56Z",
"last_at": "2023-11-07T05:31:56Z",
"occurrences": 1
}
],
"created_at": "2026-01-15T09:30:00Z",
"updated_at": "2026-01-15T09:31:12Z",
"source_image": {
"id": "550e8400-e29b-41d4-a716-446655440004",
"crn": "crn:compute:sa-saopaulo-1:platform:image/ubuntu/architecture/amd64/version/24.04",
"name": "ubuntu"
},
"source_snapshot": {
"id": "550e8400-e29b-41d4-a716-446655440011",
"crn": "crn:storage:sa-saopaulo-1:my-account:volume/data/snapshot/nightly",
"name": "nightly"
},
"device": "vdb",
"boot_index": 1,
"delete_on_termination": false,
"description": "Primary data volume for app-01",
"mount_path": "/data",
"fstype": "ext4",
"mount": {
"state": "unknown",
"code": "unsafe_serial",
"message": "/dev/disk/by-id/virtio-9f2c has a gpt partition table but no mountable filesystem, so this agent will not format it; formatting would destroy what is there",
"since": "2023-11-07T05:31:56Z",
"reported_at": "2023-11-07T05:31:56Z"
}
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication required",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "ACCESS_DENIED",
"message": "You don't have permission to perform this action",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"params": {
"instances": 2,
"pools": 0
}
}
}{
"error": {
"code": "IDEMPOTENCY_KEY_REUSED",
"message": "This Idempotency-Key was already used with a different request payload",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "An internal error occurred",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}Attach a data volume to an instance
Attach an existing, available storage volume to the instance and
record the change so the host hot-plugs
the disk into the running instance. The volume must be in the
same account and in status available.
curl --request POST \
--url https://compute.{region}.basaltic.sh/v1/instances/{instance_id}/volumes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"volume": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"device": "vdb",
"mount_path": "/data",
"fstype": "ext4"
}
'import requests
url = "https://compute.{region}.basaltic.sh/v1/instances/{instance_id}/volumes"
payload = {
"volume": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"device": "vdb",
"mount_path": "/data",
"fstype": "ext4"
}
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({
volume: '7c9e6679-7425-40de-944b-e07fc1f90ae7',
device: 'vdb',
mount_path: '/data',
fstype: 'ext4'
})
};
fetch('https://compute.{region}.basaltic.sh/v1/instances/{instance_id}/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://compute.{region}.basaltic.sh/v1/instances/{instance_id}/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([
'volume' => '7c9e6679-7425-40de-944b-e07fc1f90ae7',
'device' => 'vdb',
'mount_path' => '/data',
'fstype' => 'ext4'
]),
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://compute.{region}.basaltic.sh/v1/instances/{instance_id}/volumes"
payload := strings.NewReader("{\n \"volume\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n \"device\": \"vdb\",\n \"mount_path\": \"/data\",\n \"fstype\": \"ext4\"\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://compute.{region}.basaltic.sh/v1/instances/{instance_id}/volumes")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"volume\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n \"device\": \"vdb\",\n \"mount_path\": \"/data\",\n \"fstype\": \"ext4\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://compute.{region}.basaltic.sh/v1/instances/{instance_id}/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 \"volume\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n \"device\": \"vdb\",\n \"mount_path\": \"/data\",\n \"fstype\": \"ext4\"\n}"
response = http.request(request)
puts response.read_body{
"volume": {
"id": "5f8d2c1a-9b3e-4d7a-8c6f-1e2a3b4c5d6e",
"crn": "crn:storage:sa-saopaulo-1:my-account:volume/data-volume-01",
"name": "data-vol-01",
"tags": {
"environment": "production",
"team": "backend"
},
"volume_type": "ssd",
"size_gb": 100,
"performance": {
"requested": {
"iops": 3000,
"bytes_per_sec": 131072000,
"burst_iops": 0,
"burst_bytes_per_sec": 0,
"burst_seconds": 0
},
"applied": {
"iops": 3000,
"bytes_per_sec": 131072000,
"burst_iops": 0,
"burst_bytes_per_sec": 0,
"burst_seconds": 0
}
},
"included_io_limits": {
"iops": 3000,
"bytes_per_sec": 131072000,
"burst_iops": 0,
"burst_bytes_per_sec": 0,
"burst_seconds": 0
},
"status": "available",
"bootable": false,
"faults": [
{
"code": "BACKUP_FAILED",
"severity": "error",
"message": "Backup upload failed.",
"details": {},
"first_at": "2023-11-07T05:31:56Z",
"last_at": "2023-11-07T05:31:56Z",
"occurrences": 1
}
],
"created_at": "2026-01-15T09:30:00Z",
"updated_at": "2026-01-15T09:31:12Z",
"source_image": {
"id": "550e8400-e29b-41d4-a716-446655440004",
"crn": "crn:compute:sa-saopaulo-1:platform:image/ubuntu/architecture/amd64/version/24.04",
"name": "ubuntu"
},
"source_snapshot": {
"id": "550e8400-e29b-41d4-a716-446655440011",
"crn": "crn:storage:sa-saopaulo-1:my-account:volume/data/snapshot/nightly",
"name": "nightly"
},
"device": "vdb",
"boot_index": 1,
"delete_on_termination": false,
"description": "Primary data volume for app-01",
"mount_path": "/data",
"fstype": "ext4",
"mount": {
"state": "unknown",
"code": "unsafe_serial",
"message": "/dev/disk/by-id/virtio-9f2c has a gpt partition table but no mountable filesystem, so this agent will not format it; formatting would destroy what is there",
"since": "2023-11-07T05:31:56Z",
"reported_at": "2023-11-07T05:31:56Z"
}
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication required",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "ACCESS_DENIED",
"message": "You don't have permission to perform this action",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"params": {
"instances": 2,
"pools": 0
}
}
}{
"error": {
"code": "IDEMPOTENCY_KEY_REUSED",
"message": "This Idempotency-Key was already used with a different request payload",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "An internal error occurred",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}compute:AttachVolume. See COMPUTE permissions for the full list, what each one covers, and an example policy.Authorizations
An OAuth 2.0 bearer token, sent as Authorization: Bearer <token>.
This is the recommended way to authenticate.
Get one by exchanging a service account's access key pair at
POST /v1/oauth/token with grant_type=client_credentials. It is the
standard client-credentials grant, so any OAuth-aware library will
obtain and refresh it for you.
curl -s -u "$KEY_ID:$SECRET" -d grant_type=client_credentials \
https://iam.basaltic.sh/v1/oauth/token
Tokens last an hour by default. The same access key pair is separately your AWS SigV4 credential for the S3-compatible object endpoint, which speaks nothing else.
Headers
Optional client-generated key that makes a create replay-safe. Retrying a request with the same key returns the original outcome verbatim instead of creating a duplicate resource. Reusing a key with a different request body is rejected (422); a request whose key is still being processed returns 409. Records are honored for 24 hours. Use a UUID or similarly unique token.
255Path Parameters
Instance ID
Body
Account-scoped volume reference (UUID, CRN or exact name).
"7c9e6679-7425-40de-944b-e07fc1f90ae7"
Optional device-name override; auto-picks the next free slot (vdb/vdc/…) when omitted.
"vdb"
When set, the in-guest agent formats the disk (only if blank) and mounts it at this path. Empty attaches the block device only.
"/data"
Filesystem the in-guest agent formats the disk with, and only when mount_path is set and the disk is blank. Rejected with 400 if it is neither value.
ext4, xfs Response
Attachment accepted
Show child attributes
Show child attributes

