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"
}
'
{
  "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"