ByCloud Docs
GuidesCLIAPISDK
post/v1/storage/backups/{backup_id}/restore

Restore backup

Restore a backup to a new or existing volume

Path Parameters

backup_id

string<uuid>required

path

Backup ID

Example: "550e8400-e29b-41d4-a716-446655440000"

Header Parameters

X-Region

stringrequired

header

Region code to query resources from. Required for all resource operations.

Example: "sao1"

Request Body

optional

Content-Type: application/json

volume_id

string<uuid>optional

Existing volume to restore to (creates new volume if omitted)

name

stringoptional

Name for new volume (if not restoring to existing)

Responses

202

Restore initiated

Content-Type: application/json

volume_id

string<uuid>optional

ID of the volume being restored to

400

Invalid request parameters

Content-Type: application/json

error

objectrequired
401

Authentication required or token invalid

Content-Type: application/json

error

objectrequired
404

Resource not found

Content-Type: application/json

error

objectrequired
409

Backup is not in restorable state

Content-Type: application/json

error

objectrequired
500

Internal server error

Content-Type: application/json

error

objectrequired
curl -X POST "https://api.spo1.mycloud.com/v1/storage/backups/550e8400-e29b-41d4-a716-446655440000/restore" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "volume_id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "string"
  }'

Response

Restore initiated

{
  "volume_id": "550e8400-e29b-41d4-a716-446655440000"
}