Version
GET

List recovery operations

/v1/recovery/operations in the Disaster Recovery API.

curl "https://api.subscriby.net/v1/recovery/operations?kind=resources&status=completed" \  -H "Authorization: Bearer $SUBSCRIBY_TOKEN"

An operation is one recovery: run by the creator, by the platform on their behalf (automatic: true, the failover you sleep through), or on demand (on_demand: true, a Swap & Grant of a healthy resource, which spends no allowance). The row exists from the moment the recovery starts, because it is the quota ledger and the audit trail at once.

Both filters are optional: kind is account, bot or resources; status is started, completed, failed or reverted. Newest first by started_at; sort_by also accepts kind, status and completed_at.

GET
/v1/recovery/operations

The token must hold this ability, or the call is refused with 403.

Runs the same action from an agent, behind the same ability.

Authorization

bearerToken
AuthorizationBearer <token>

A personal access token minted on the dashboard under Settings, then Tokens, sent as Authorization: Bearer sbt_live_…. The token carries the abilities each endpoint lists under Requires ability and is frozen to one team.

In: header

Query Parameters

kind?|

Narrow to one kind: account, bot or resources. An unknown value is refused.

status?|

Narrow to one status: started, completed, failed or reverted. An unknown value is refused.

page?integer

The 1-based page to return. A page past the last answers an empty data array with meta.total still filled, so a loop can stop without guessing.

Range1 <= value
Default1
per_page?integer

Rows per page, 1 to 100. A higher value clamps to the cap silently. Defaults to 25.

Range1 <= value <= 100
Default25
sort_by?string

The column to order by. Defaults to started_at; a column the endpoint does not offer falls back to the default rather than failing.

Default"started_at"
sort_direction?string

asc or desc. Defaults to desc.

Default"desc"

Value in

  • "asc"
  • "desc"

Responses

200OK

The page, newest first by default.

401Unauthorized

The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).

403Forbidden

The token is valid but does not carry the ability this endpoint requires; error.context.required_ability names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers FORBIDDEN, TEAM_TIER_REQUIRED or CONNECTOR_TIER_REQUIRED with the same status, and says so in its own description.

422Validation failed

The payload broke a rule, and error.fields maps each offending key to its messages. A refusal from the domain, such as a plan that cannot go on sale or a member who cannot be removed, uses the same code with error.message saying why and no fields. On this endpoint: VALIDATION_FAILED: when kind or status is not one of its values.

429Too many requests

The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.

How is this guide?

Last updated on