Start an encrypted disaster-recovery backup and return its job id (501 without the DR service)

POST

/v1/console/dr/backup

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

• this engine

Starts an encrypted disaster-recovery backup of the store and returns the job’s id (202); follow the job at /v1/console/dr/jobs/{job_id}/stream. The passphrase must meet the documented floor and encrypts the backup keys.

Authorizations

• bearerAuth
• browserSession

Request Body ^required

Media type application/json

object

notes

string

passphrase

required

Passphrase encrypting the backup keys; must meet the documented floor.

string

Example ^generated

{
  "notes": "example",
  "passphrase": "example"
}

Responses

202

Accepted: the backup job started; follow it at /v1/console/dr/jobs/{job_id}/stream

Media type application/json

object

job_id

required

string

Example ^generated

{
  "job_id": "example"
}

400

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"
  }
}

401

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"
  }
}

403

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"
  }
}

404

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"
  }
}

409

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"
  }
}

429

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"
  }
}