Update a Volume
curl --request PATCH \
--url https://api.example.com/v2/sandboxes/volumes/{name} \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"size": "10Gi"
}
'import requests
url = "https://api.example.com/v2/sandboxes/volumes/{name}"
payload = {
"name": "<string>",
"size": "10Gi"
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', size: '10Gi'})
};
fetch('https://api.example.com/v2/sandboxes/volumes/{name}', 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/v2/sandboxes/volumes/{name}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'size' => '10Gi'
]),
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/v2/sandboxes/volumes/{name}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"size\": \"10Gi\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.example.com/v2/sandboxes/volumes/{name}")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"size\": \"10Gi\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v2/sandboxes/volumes/{name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"size\": \"10Gi\"\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"size": "<string>",
"storage_class": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "<string>",
"updated_at": "<string>"
}{
"detail": {
"error": "ResizeError",
"message": "Storage cannot be decreased. Current: 5.00Gi, Requested: 2.00Gi"
}
}{
"detail": {
"error": "NotFound",
"message": "Resource not found."
}
}{
"detail": {
"error": "Conflict",
"message": "Volume 'new-name' already exists"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "Sandbox storage quota exceeded. Limit: 10Gi, Current usage: 8.00Gi, Requested increase: 5.00Gi."
}Update a Volume
Update a volume’s display name and/or storage size.
You can update:
- name: New display name (must be unique within the organization)
- size: New storage size (only increases allowed, cannot decrease)
The storage increase is subject to quota limits configured via Metronome org config.
PATCH
/
v2
/
sandboxes
/
volumes
/
{name}
Update a Volume
curl --request PATCH \
--url https://api.example.com/v2/sandboxes/volumes/{name} \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"size": "10Gi"
}
'import requests
url = "https://api.example.com/v2/sandboxes/volumes/{name}"
payload = {
"name": "<string>",
"size": "10Gi"
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', size: '10Gi'})
};
fetch('https://api.example.com/v2/sandboxes/volumes/{name}', 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/v2/sandboxes/volumes/{name}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'size' => '10Gi'
]),
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/v2/sandboxes/volumes/{name}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"size\": \"10Gi\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.example.com/v2/sandboxes/volumes/{name}")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"size\": \"10Gi\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v2/sandboxes/volumes/{name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"size\": \"10Gi\"\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"size": "<string>",
"storage_class": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "<string>",
"updated_at": "<string>"
}{
"detail": {
"error": "ResizeError",
"message": "Storage cannot be decreased. Current: 5.00Gi, Requested: 2.00Gi"
}
}{
"detail": {
"error": "NotFound",
"message": "Resource not found."
}
}{
"detail": {
"error": "Conflict",
"message": "Volume 'new-name' already exists"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "Sandbox storage quota exceeded. Limit: 10Gi, Current usage: 8.00Gi, Requested increase: 5.00Gi."
}Path Parameters
Volume name
Body
application/json
Request model for updating a Volume.
You can update the display name and/or the storage size. Storage can only be increased (cannot be decreased due to K8s PVC limitations).
Was this page helpful?
⌘I

