Create volume

Create a new volume in the project and region. The volume can be created from scratch, from an image, or from a snapshot. Optionally attach the volume to an instance during creation.

POST /cloud/v1/volumes/{project_id}/{region_id}

Create volume

cURL

curl --request POST \
  --url https://api.gcore.com/cloud/v1/volumes/{project_id}/{region_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "instance_id_to_attach_to": "88f3e0bd-ca86-4cf7-be8b-dd2988e23c2d",
  "name": "volume-1",
  "size": 10,
  "source": "new-volume",
  "type_name": "ssd_hiiops"
}
'

import requests

url = "https://api.gcore.com/cloud/v1/volumes/{project_id}/{region_id}"

payload = {
    "instance_id_to_attach_to": "88f3e0bd-ca86-4cf7-be8b-dd2988e23c2d",
    "name": "volume-1",
    "size": 10,
    "source": "new-volume",
    "type_name": "ssd_hiiops"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    instance_id_to_attach_to: '88f3e0bd-ca86-4cf7-be8b-dd2988e23c2d',
    name: 'volume-1',
    size: 10,
    source: 'new-volume',
    type_name: 'ssd_hiiops'
  })
};

fetch('https://api.gcore.com/cloud/v1/volumes/{project_id}/{region_id}', 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.gcore.com/cloud/v1/volumes/{project_id}/{region_id}",
  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([
    'instance_id_to_attach_to' => '88f3e0bd-ca86-4cf7-be8b-dd2988e23c2d',
    'name' => 'volume-1',
    'size' => 10,
    'source' => 'new-volume',
    'type_name' => 'ssd_hiiops'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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.gcore.com/cloud/v1/volumes/{project_id}/{region_id}"

	payload := strings.NewReader("{\n  \"instance_id_to_attach_to\": \"88f3e0bd-ca86-4cf7-be8b-dd2988e23c2d\",\n  \"name\": \"volume-1\",\n  \"size\": 10,\n  \"source\": \"new-volume\",\n  \"type_name\": \"ssd_hiiops\"\n}")

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

	req.Header.Add("Authorization", "<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.gcore.com/cloud/v1/volumes/{project_id}/{region_id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"instance_id_to_attach_to\": \"88f3e0bd-ca86-4cf7-be8b-dd2988e23c2d\",\n  \"name\": \"volume-1\",\n  \"size\": 10,\n  \"source\": \"new-volume\",\n  \"type_name\": \"ssd_hiiops\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/cloud/v1/volumes/{project_id}/{region_id}")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"instance_id_to_attach_to\": \"88f3e0bd-ca86-4cf7-be8b-dd2988e23c2d\",\n  \"name\": \"volume-1\",\n  \"size\": 10,\n  \"source\": \"new-volume\",\n  \"type_name\": \"ssd_hiiops\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "tasks": [
    "d478ae29-dedc-4869-82f0-96104425f565"
  ]
}

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

CreateVolumeFromImageSerializer

CreateVolumeFromSnapshotSerializer

CreateNewVolumeSerializer

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

Pattern: ^[a-zA-Z0-9][a-zA-Z 0-9._\-]{1,61}[a-zA-Z0-9._]$

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

Pattern: ^[^,/]{1,60}$

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 · CreateTagsSerializer · 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. Both tag keys and values have a maximum length of 255 characters. 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.

Show child attributes

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 representing asynchronous operations. Use these IDs to monitor operation progress:

• GET /v1/tasks/{task_id} - Check individual task status and details Poll task status until completion (FINISHED/ERROR) before proceeding with dependent operations.

Example:

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