Skip to main content
POST
/
cloud
/
v1
/
snapshots
/
{project_id}
/
{region_id}
Create snapshot
curl --request POST \
  --url https://api.gcore.com/cloud/v1/snapshots/{project_id}/{region_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "volume_id": "<string>",
  "description": "<string>",
  "tags": {}
}
'
{
  "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

​
region_id
integer
required

Region ID

Body

application/json
​
name
string
required

Snapshot name

Example:

"my-snapshot"

​
volume_id
string<uuid4>
required

Volume ID to make snapshot of

Example:

"67baa7d1-08ea-4fc5-bef2-6b2465b7d227"

​
description
string

Snapshot description

Example:

"Snapshot description"

​
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.

Example:
{ "my-tag": "my-tag-value" }

Response

Created task ID

​
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"]