The scheduled-backup configuration and its last run's outcome

GET

/v1/console/dr/schedule

curl --request GET \
  --url https://example.com/v1/console/dr/schedule \
  --header 'Authorization: Bearer <token>'

• this engine

Returns the scheduled-backup configuration: enabled, cron, retention, the last scheduled run’s outcome, and the effective dual-control restore gate with any pending disarm instant.

Authorizations

• bearerAuth
• browserSession

Responses

200

OK

Media type application/json

object

cron

required

string

dual_control_disarm_effective_at

string format: date-time

dual_control_disarm_requested_by

string

enabled

required

boolean

last_run

string format: date-time

last_run_error

string

last_run_status

The most recent scheduled run’s outcome, so a failing schedule is not a silent gap.

string

Allowed values: completed failed

next_run

string format: date-time

require_dual_control_restore

required

The effective console restore gate. When armed, a distinct administrator account must approve; CLI restore uses a declared-operator record instead, so estates requiring approval for every restore must also control host access.

boolean

retain_days

required

integer

Example

{
  "last_run_status": "completed"
}

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