Skip to main content
POST
/
cloud
/
v1
/
volumes
/
{project_id}
/
{region_id}
Python
import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
task_id_list = client.cloud.volumes.create(
    project_id=1,
    region_id=1,
    image_id="169942e0-9b53-42df-95ef-1a8b6525c2bd",
    name="volume-1",
    size=10,
    source="image",
)
print(task_id_list.tasks)
{
  "tasks": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

​
project_id
integer
required

Project ID

Example:

1

​
region_id
integer
required

Region ID

Example:

1

Body

application/json

Volume can be created from image, snapshot or as a new volume

​
image_id
string<uuid4>
required

Image ID

Example:

"169942e0-9b53-42df-95ef-1a8b6525c2bd"

​
name
string
required

Volume name

Example:

"volume-1"

​
size
integer
required

Volume size in GiB

Required range: x >= 1
Example:

10

​
source
string
required

Volume source type

Allowed value: "image"
Example:

"image"

​
attachment_tag
string

Block device attachment tag (not exposed in the user tags). Only used in conjunction with instance_id_to_attach_to

Example:

"device-tag"

​
instance_id_to_attach_to
string

instance_id to attach newly-created volume to

Example:

"88f3e0bd-ca86-4cf7-be8b-dd2988e23c2d"

​
lifecycle_policy_ids
integer[]

List of lifecycle policy IDs (snapshot creation schedules) to associate with the volume

Example:
[1, 2]
​
tags
UpdateTagsSerializer · object

Key-value tags to associate with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.

Example:
{ "my-tag": "my-tag-value" }
​
type_name
enum<string>

Volume type. Defaults to standard. If not specified for source snapshot, volume type will be derived from the snapshot volume.

Available options:
cold,
ssd_hiiops,
ssd_local,
ssd_lowlatency,
standard,
ultra
Example:

"standard"

Response

200 - application/json

OK

​
tasks
string[]
required

List of task IDs

Example:
["d478ae29-dedc-4869-82f0-96104425f565"]