ByCloud Docs
GuidesCLIAPISDK
post/v1/database-backups/{database_backup_id}/restore

Restore database backup

Restore a database backup to a new instance

Path Parameters

database_backup_id

string<uuid>required

path

Database Backup ID

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

Request Body

required

Content-Type: application/json

name

stringrequired

Name for the new restored instance

flavor_id

string<uuid>optional

Flavor for restored instance (uses original if omitted)

volume_size

integeroptional

Volume size for restored instance (uses original if omitted)

Responses

202

Restore initiated

Content-Type: application/json

database_instance

objectoptional
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/database-backups/550e8400-e29b-41d4-a716-446655440000/restore" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "flavor_id": "550e8400-e29b-41d4-a716-446655440000",
    "volume_size": 1
  }'

Response

Restore initiated

{
  "database_instance": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "crn": "crn:spo1:database:instance:550e8400-e29b-41d4-a716-446655440000",
    "name": "production-db",
    "status": "ACTIVE",
    "operating_status": "string",
    "datastore": {
      "type": "postgresql",
      "version": "15.4",
      "version_id": "550e8400-e29b-41d4-a716-446655440000"
    },
    "flavor": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "db.m1.medium"
    },
    "volume": {
      "size": 50,
      "type": "ssd",
      "used": 0
    },
    "region": "spo1",
    "addresses": [
      {
        "address": "192.168.1.50",
        "type": "private",
        "network": "string"
      }
    ],
    "hostname": "550e8400.db.spo1.mycloud.com",
    "ip": [
      "string"
    ],
    "replicas": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "string"
      }
    ],
    "replica_of": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "string"
    },
    "configuration": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "string"
    },
    "public_access": false,
    "ssl_enabled": true,
    "backup_schedule": {
      "enabled": true,
      "time": "03:00",
      "retention_days": 7
    },
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
}