API › Account

Your plan and quotas

Your plan, your API access, and what you have left this period in quick scans, audits and fixes. Call it before a loop of scans so you do not hit a 402.

GEThttps://api.rustine.io/v1/account

OAuth permission: scans:read · an API key has them all

Open in Claude Open in ChatGPT

Response

objectstring
workspaceobject
- idstring
  Workspace id.
- namestring
  Workspace name.
planstring
The plan in force (Free, Solo or Pro).
freesolopro
api_accessobject
- allowedboolean
  Whether the API and the MCP server answer now.
- trial_ends_atstring | null
  Solo only: end of the 14-day trial once started; null on Pro, or before the first call.
periodobject
- startstring
  Start of the current 30-day quota period.
- endstring
  When the counters reset.
quotasobject
- quick_scansobject
  - limitinteger
    Units included this period (all the projects the workspace pays for).
  - usedinteger
    Units used this period.
  - remaininginteger
    Units left this period, before pack credits.
- auditsobject
  - limitinteger
    Units included this period (all the projects the workspace pays for).
  - usedinteger
    Units used this period.
  - remaininginteger
    Units left this period, before pack credits.
- fixesobject
  - limitinteger
    Units included this period (all the projects the workspace pays for).
  - usedinteger
    Units used this period.
  - remaininginteger
    Units left this period, before pack credits.
free_fixes_leftinteger
Fixes given once to a Free workspace, still unused.
pack_creditsobject
- scansinteger
  Scan credits from packs, used once the period's quota is spent.
- fixesinteger
  Fix credits from packs, used once the period's quota is spent.
projectsobject
- limitinteger
  Open projects allowed by the plan (included and extra).
- usedinteger
  Projects in the workspace, paused ones included.
- pausedinteger
  Projects paused because the plan covers fewer projects.
addresses_per_projectinteger
Addresses (hostnames) a project may follow on this plan.
featuresobject
- full_auditboolean
  Full audits (Solo, Pro).
- repositoriesboolean
  GitHub repository analyses (Solo, Pro).
- ai_fixboolean
  AI Fix, Rustine writes the patch (Solo, Pro).
- alertsboolean
  Score-drop and new-advisory alerts (Pro).

Errors

Status	error.code	What happens
401	authentication_required	No key in the request. Pass it in the `Authorization: Bearer rst_…` header, never in the address.
401	invalid_api_key	The key or OAuth token is wrong, revoked or expired. Check it is copied in full, or create a new key.
402	api_plan_required	The workspace is on the Free plan. The API comes with Pro, or on a 14-day trial with Solo.
402	api_trial_ended	Solo's 14-day trial is over. Move to Pro: your keys work again at once.
403	scope_missing	The OAuth token lacks the permission this route needs (shown on its page). Reconnect the agent to grant it. An API key has every permission.
429	rate_limited	Too many requests for this key (120 per minute). Wait `Retry-After` seconds.
500	internal_error	An error on our side, reported automatically. Retry later; give the `Request-Id` to support if it comes back.
503	service_unavailable	Rustine is unavailable for a moment. Retry with the same `Idempotency-Key`.