Version
GET

Get a recovery operation

/v1/recovery/operations/{operation} in the Disaster Recovery API.

curl https://api.subscriby.net/v1/recovery/operations/$OPERATION_ID \  -H "Authorization: Bearer $SUBSCRIBY_TOKEN"

One operation, with its undo state.

  • status is started while the recovery runs, then completed, failed (with failure_reason) or reverted.
  • revertible says whether the creator may still undo it right now: it is completed, of a kind that can be undone (an account relink or a channel swap, never a bot replacement), and inside the undo window that revert_window_ends_at closes. A client should show the undo exactly when this is true.
  • grant_id names the support grant that paid for the recovery when the self-service allowance was already spent; null otherwise.
GET
/v1/recovery/operations/{operation}

Requires ability

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

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

Path Parameters

operation*string

The operation, resolved within the ledger by the route binder.

Formatuuid

Responses

200OK

200 with the operation.

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.

404Not found

An id in the path names nothing the token can see. TENANT_MISMATCH: the project sits outside the token's scope:project: allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.

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