Create a persistent volume on a workspace.
curl --request POST \
--url https://api.rigbox.dev/api/v1/workspaces/{id}/volumes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"mount_path": "<string>",
"name": "<string>",
"size_mb": 1
}
'import requests
url = "https://api.rigbox.dev/api/v1/workspaces/{id}/volumes"
payload = {
"mount_path": "<string>",
"name": "<string>",
"size_mb": 1
}
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({mount_path: '<string>', name: '<string>', size_mb: 1})
};
fetch('https://api.rigbox.dev/api/v1/workspaces/{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://api.rigbox.dev/api/v1/workspaces/{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([
'mount_path' => '<string>',
'name' => '<string>',
'size_mb' => 1
]),
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.rigbox.dev/api/v1/workspaces/{id}/volumes"
payload := strings.NewReader("{\n \"mount_path\": \"<string>\",\n \"name\": \"<string>\",\n \"size_mb\": 1\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.rigbox.dev/api/v1/workspaces/{id}/volumes")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"mount_path\": \"<string>\",\n \"name\": \"<string>\",\n \"size_mb\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.rigbox.dev/api/v1/workspaces/{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 \"mount_path\": \"<string>\",\n \"name\": \"<string>\",\n \"size_mb\": 1\n}"
response = http.request(request)
puts response.read_body{
"volume": {
"created_at": "2023-11-07T05:31:56Z",
"host_path": "<string>",
"id": "<string>",
"mount_path": "<string>",
"name": "<string>",
"node_id": "<string>",
"size_mb": 1,
"workspace_id": "<string>",
"migrated_at": "2023-11-07T05:31:56Z"
}
}Create a persistent volume mounted into this workspace at a path.
POST
/
api
/
v1
/
workspaces
/
{id}
/
volumes
Create a persistent volume on a workspace.
curl --request POST \
--url https://api.rigbox.dev/api/v1/workspaces/{id}/volumes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"mount_path": "<string>",
"name": "<string>",
"size_mb": 1
}
'import requests
url = "https://api.rigbox.dev/api/v1/workspaces/{id}/volumes"
payload = {
"mount_path": "<string>",
"name": "<string>",
"size_mb": 1
}
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({mount_path: '<string>', name: '<string>', size_mb: 1})
};
fetch('https://api.rigbox.dev/api/v1/workspaces/{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://api.rigbox.dev/api/v1/workspaces/{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([
'mount_path' => '<string>',
'name' => '<string>',
'size_mb' => 1
]),
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.rigbox.dev/api/v1/workspaces/{id}/volumes"
payload := strings.NewReader("{\n \"mount_path\": \"<string>\",\n \"name\": \"<string>\",\n \"size_mb\": 1\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.rigbox.dev/api/v1/workspaces/{id}/volumes")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"mount_path\": \"<string>\",\n \"name\": \"<string>\",\n \"size_mb\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.rigbox.dev/api/v1/workspaces/{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 \"mount_path\": \"<string>\",\n \"name\": \"<string>\",\n \"size_mb\": 1\n}"
response = http.request(request)
puts response.read_body{
"volume": {
"created_at": "2023-11-07T05:31:56Z",
"host_path": "<string>",
"id": "<string>",
"mount_path": "<string>",
"name": "<string>",
"node_id": "<string>",
"size_mb": 1,
"workspace_id": "<string>",
"migrated_at": "2023-11-07T05:31:56Z"
}
}See persistent volumes for mounting, capacity, and recovery guidance. Workspace root filesystem snapshots do not include volume contents.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Workspace ID
Body
application/json
Response
201 - application/json
Volume created
A persistent volume attached to a workspace VM.
Backed by a host ext4 file (host_path) mounted in-guest at mount_path
via a second Firecracker drive. Separate from the rootfs image, so its data
survives a rootfs/image swap. Serialized over the wire for rig volume.
Show child attributes
Show child attributes