Skip to main content
POST
Restore a disk backup

Authorizations

Authorization
string
header
required

Send your API token as Authorization: Bearer <api-token>.

Path Parameters

projectID
string
required

ID of the app that owns the backed-up disk. 24-character hexadecimal ID.

Pattern: ^[0-9a-fA-F]{24}$
name
string
required

Name of the backed-up disk.

Query Parameters

teamID
string

Run the request in the context of a team you belong to, instead of your personal account. 24-character hexadecimal ID.

Pattern: ^[0-9a-fA-F]{24}$

Body

application/json
backupName
string
required

The backup's name from the backups list.

Maximum string length: 100
targetProjectID
string
required

ID of the app to restore into.

Pattern: ^[0-9a-fA-F]{24}$
targetDiskName
string
required

Lowercase letters, digits and hyphens; can't start or end with a hyphen.

Minimum string length: 3
Pattern: ^[a-z0-9][a-z0-9\-]+[a-z0-9]$

Response

The restore started. The response body is empty.