POST
Recreate a machine from a workspace backup

Authorizations

Authorization
string
header
required

An opaque BMA personal or organization bearer token.

Path Parameters

orgID
string
required

Organization ID (org_...).

Pattern: ^org_[a-z2-7]{26}$
projectID
string
required

Project ID (proj_...).

Pattern: ^proj_[a-z2-7]{26}$
machineID
string
required

Machine ID (mch_...).

Pattern: ^mch_[a-z2-7]{26}$

Body

application/json
backup_id
string

The ready backup to restore; defaults to the newest.

Pattern: ^mbk_[a-z2-7]{26}$

Response

The machine is being recreated; this is the backup it restores.

id
string
required
Pattern: ^mbk_[a-z2-7]{26}$
machine_id
string
required

Machine ID (mch_...).

Pattern: ^mch_[a-z2-7]{26}$
state
enum<string>
required
Available options:
uploading,
ready,
failed
reason
enum<string>
required

What took the backup.

Available options:
pause,
periodic,
manual
paths
string[]
required
exclude
string[]
required
size_bytes
integer<int64> | null
required

Archive size; set once ready.

digest
string | null
required

SHA-256 digest of the tar+zstd archive; set once ready.

error
string
required

Why a failed backup failed; empty otherwise.

created_at
string<date-time>
required
completed_at
string<date-time> | null
required