Skip to main content
POST
/
volumes
/
create
/volumes/create
curl --request POST \
  --url https://api.shadeform.ai/v1/volumes/create \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "cloud": "hyperstack",
  "region": "canada-1",
  "size_in_gb": 100,
  "name": "My storage volume"
}
'
import requests

url = "https://api.shadeform.ai/v1/volumes/create"

payload = {
"cloud": "hyperstack",
"region": "canada-1",
"size_in_gb": 100,
"name": "My storage volume"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
cloud: 'hyperstack',
region: 'canada-1',
size_in_gb: 100,
name: 'My storage volume'
})
};

fetch('https://api.shadeform.ai/v1/volumes/create', 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.shadeform.ai/v1/volumes/create",
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([
'cloud' => 'hyperstack',
'region' => 'canada-1',
'size_in_gb' => 100,
'name' => 'My storage volume'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);

$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.shadeform.ai/v1/volumes/create"

payload := strings.NewReader("{\n \"cloud\": \"hyperstack\",\n \"region\": \"canada-1\",\n \"size_in_gb\": 100,\n \"name\": \"My storage volume\"\n}")

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

req.Header.Add("X-API-KEY", "<api-key>")
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.shadeform.ai/v1/volumes/create")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"cloud\": \"hyperstack\",\n \"region\": \"canada-1\",\n \"size_in_gb\": 100,\n \"name\": \"My storage volume\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.shadeform.ai/v1/volumes/create")

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

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cloud\": \"hyperstack\",\n \"region\": \"canada-1\",\n \"size_in_gb\": 100,\n \"name\": \"My storage volume\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "78a0dd5a-dbb1-4568-b55c-5e7e0a8b0c40"
}

Authorizations

X-API-KEY
string
header
required

Body

application/json
cloud
string
required

Specifies the underlying cloud provider. See this explanation for more details.

Example:

"hyperstack"

region
string
required

Specifies the region.

Example:

"canada-1"

size_in_gb
integer
required

Storage volume size in GB

Example:

100

name
string
required

The name of the storage volume.

Example:

"My storage volume"

Response

200 - application/json

Returns a CreateVolumeResponse object

id
string
required

The ID of the storage volume.

Example:

"78a0dd5a-dbb1-4568-b55c-5e7e0a8b0c40"