Backups

Backups are point-in-time snapshots of servers and instances. They can be restored to create new resources.

List Backups

GET /v1/servers/:id/backups

Returns backups for a bare metal server.

GET /v1/instances/:instanceId/backups

Returns backups for a virtual machine instance.

POST /v1/servers/:id/backups

Request body:

{
  "data": {
    "type": "backups",
    "attributes": {
      "name": "backup-before-upgrade"
    }
  }
}

POST /v1/instances/:instanceId/backups

Request body:

{
  "data": {
    "type": "backups",
    "attributes": {
      "name": "backup-before-upgrade"
    }
  }
}

POST /v1/backups/:id/restore

Creates a new server or instance from a backup. The source resource type determines what is created:

The original backup is archived after restore.

DELETE /v1/backups/:id

Returns 204 No Content. Backup is archived and no longer available for restore.

Field	Type	Description
`id`	string	Unique backup identifier
`instanceId`	string?	Associated instance ID (VMs)
`serverId`	string?	Associated server ID (bare metal)
`projectId`	string	Project ID
`name`	string	Backup name
`sizeGb`	integer?	Backup size in GB
`status`	string	`creating`, `ready`, `failed`, `archived`
`createdAt`	string	ISO 8601 creation timestamp
`updatedAt`	string	ISO 8601 update timestamp

Value	Description
`creating`	Backup is being created
`ready`	Backup is available for restore
`failed`	Backup creation failed
`archived`	Backup has been restored or deleted