Skip to content

Apply an uploaded bundle: with the dual-control gate armed this records an intent for a second administrator to approve (request_id); otherwise it starts the restore job (job_id)

POST
/v1/console/dr/restore/{id}/apply
curl --request POST \
--url https://example.com/v1/console/dr/restore/example/apply \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "passphrase": "example" }'

Applies an uploaded bundle. With the dual-control gate armed this records an intent for a distinct administrator to approve (202 with request_id); otherwise it starts the restore job (202 with job_id). A delegated credential cannot pass the gate.

id
required
string
>= 1 characters

The id returned by the upload.

Media type application/json
object
passphrase
required

Passphrase decrypting the backup keys (the single-actor path).

string
Example generated
{
"passphrase": "example"
}

Accepted

Media type application/json

The apply outcome: a job id (single-actor path) OR an awaiting-approval request id (dual-control path).

object
awaiting_approval

True when the dual-control gate armed and the restore records an intent instead of running.

boolean
initiator
string
job_id
string
request_id

The pending request a distinct administrator approves.

string
Example generated
{
"awaiting_approval": true,
"initiator": "example",
"job_id": "example",
"request_id": "example"
}

Bad request

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated
{
"error": {
"code": "example",
"message": "example",
"module": "example"
}
}

Unauthenticated

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated
{
"error": {
"code": "example",
"message": "example",
"module": "example"
}
}

Forbidden

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated
{
"error": {
"code": "example",
"message": "example",
"module": "example"
}
}

Not found

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated
{
"error": {
"code": "example",
"message": "example",
"module": "example"
}
}

Conflict / setup required

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated
{
"error": {
"code": "example",
"message": "example",
"module": "example"
}
}

Rate limited

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated
{
"error": {
"code": "example",
"message": "example",
"module": "example"
}
}