API reference
The HTTP interface used by the app, integrations, and administration tools.
Auth levels: public, user (any signed-in account), admin. Public auth endpoints are rate-limited to 10 requests/minute/IP. Internally, authorization is permission-based (users:manage, requests:manage, remediation:manage, instances:manage, arr:browse, …): “admin” below means the admin role holds the required permission and the user role doesn’t.
Choose a group below for routes, request fields, access rules, and response behavior. These pages are built from the server reference in the same checkout.
- Auth & account
- External OIDC sign-in
- Users, devices & connect links (admin)
- Apple TV / Infuse
- Media server accounts
- Setup status (admin)
- Update status (admin)
- Discovery settings (admin)
- Outbound proxy (admin)
- Seerr-compatible API key (admin)
- Push notification policy (admin)
- Discord notifications
- AI configuration history (admin)
- Profile change proposals (admin)
- Requests
- Issues & AI remediation
- Discover & media (user)
- AI chat (user)
- Included AI profile (admin)
- AI tool toggles (admin)
- Instances & arr proxy
- Assignments and routing defaults
- Completed media downloads (user)
- Download activity
- Downloads & monitoring (admin)
- Tdarr progress (admin)
- Push & notification preferences (user)
- Webhooks (credential-authenticated, no session)
- Seerr-compatible API (
X-Api-Key, no session) - MCP & OAuth (external tool access)
- Real-time