This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Create a snapshot

1: 1.3
2: 1.2
3: 1.1
4: 1.0

1 - 1.3

post /v1/snapshots

Description

Create a volume snapshot. This snapshot is a full copy of the volume. You can create a volume from the snapshot that was created.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
body	body required		SnapshotCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	SnapshotDetailResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/snapshots

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Request body

{
    "description": "description",
    "force": true,
    "metadata": "",
    "name": "snapshot-1",
    "volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}

Example HTTP response

Response 202

{
    "created_at": "2025-07-22T09:00:00Z",
    "description": "description",
    "id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
    "metadata": "Metadata",
    "name": "snapshot-1",
    "size": 104,
    "status": "available",
    "updated_at": "2025-07-26T12:00:00Z",
    "user_id": "570907805e5447be84b618450ef52o0t",
    "volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}

2 - 1.2

post /v1/snapshots

Description

Create a volume snapshot. This snapshot is a full copy of the volume. You can create a volume from the snapshot that was created.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

Parameters

Type	Name	Description	Schema	Default
body	body required		SnapshotCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	SnapshotDetailResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/snapshots

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"

Request body

{
    "description": "description",
    "force": true,
    "metadata": "",
    "name": "snapshot-1",
    "volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}

Example HTTP response

Response 202

{
    "created_at": "2025-07-22T09:00:00Z",
    "description": "description",
    "id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
    "metadata": "Metadata",
    "name": "snapshot-1",
    "size": 104,
    "status": "available",
    "updated_at": "2025-07-26T12:00:00Z",
    "user_id": "570907805e5447be84b618450ef52o0t",
    "volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}

3 - 1.1

post /v1/snapshots

Description

Create a volume snapshot. This snapshot is a full copy of the volume. You can create a volume from the snapshot that was created.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.1	20260531

Parameters

Type	Name	Description	Schema	Default
body	body required		SnapshotCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	SnapshotDetailResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/snapshots

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"

Request body

{
    "description": "description",
    "force": true,
    "metadata": "",
    "name": "snapshot-1",
    "volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}

Example HTTP response

Response 202

{
    "created_at": "2025-07-22T09:00:00Z",
    "description": "description",
    "id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
    "metadata": "Metadata",
    "name": "snapshot-1",
    "size": 104,
    "status": "available",
    "updated_at": "2025-07-26T12:00:00Z",
    "user_id": "570907805e5447be84b618450ef52o0t",
    "volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}

4 - 1.0

post /v1/snapshots

Description

Create a volume snapshot. This snapshot is a full copy of the volume. You can create a volume from the snapshot that was created.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		SnapshotCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	SnapshotDetailResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/snapshots

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"

Request body

{
    "description": "description",
    "force": true,
    "metadata": "",
    "name": "snapshot-1",
    "volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}

Example HTTP response

Response 202

{
    "created_at": "2025-07-22T09:00:00Z",
    "description": "description",
    "id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
    "metadata": "Metadata",
    "name": "snapshot-1",
    "size": 104,
    "status": "available",
    "updated_at": "2025-07-26T12:00:00Z",
    "user_id": "570907805e5447be84b618450ef52o0t",
    "volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}