get_recovery_allowances

Read how many self-service Disaster Recoveries of each kind the creator the token acts for may still run, what support has released on top, and when the allowance returns. Takes no input.

Purpose

Answer "can I still run a recovery, or do I need support?". Self-service recovery is allowed once per kind (account, bot, resources) inside a rolling window; beyond that, support reviews the account and may release a grant. Each row carries what the window still allows (self_service_remaining), what support has released and not yet spent (grant_remaining), their sum (remaining), whether a recovery of that kind would be allowed right now (allowed), whether the next one would spend a grant (uses_grant), when the kind was last recovered and when the self-service allowance returns. meta carries the window itself. The rows are the ones GET /v1/recovery/allowances returns.

Required ability

project-recovery:view-any

Input schema

{
  "type": "object",
  "properties": {}
}

Output shape

{
  "data": [
    {
      "kind": "resources",
      "kind_label": "Channels and Groups",
      "self_service_remaining": 0,
      "grant_remaining": 1,
      "remaining": 1,
      "allowed": true,
      "uses_grant": true,
      "last_used_at": "2026-09-12T03:19:10Z",
      "next_self_service_at": "2026-12-11T03:19:10Z"
    }
  ],
  "meta": { "window_days": 90, "self_service_uses": 1 }
}

One row per kind, in the order account, bot, resources.

Example prompts

"If a channel gets banned tonight, will the platform be allowed to swap it for me?"

"When does my self-service channel recovery come back?"

Failure modes

  • AUTHENTICATION_REQUIRED — no authenticated user on the request.
  • TOKEN_MISSING_ABILITY — token lacks project-recovery:view-any.

How is this guide?

On this page

Subscriby is a product designed by you — for you.

No boardroom full of executives deciding what we ships next. Our roadmap always shaped by you with your feedback.

Share feedback or a request