Bairav Portal API
The Portal API is what the Bairav console uses. Everything you can do in the console you can do here, within your role.
Authentication. Sign in with POST /api/auth/breakglass to get a 1-hour access token and a 14-day refresh token, then send Authorization: Bearer <access token>. Your tenant comes from the token. Never send a tenant ID in a request body.
Conventions. Paths are under /api/ and are not versioned. Errors are {"detail": ...}. Lists return {"items": [...]} and page with limit and cursor. Every response carries X-Request-ID (send your own to correlate).
What this reference does not yet describe. Request bodies are fully described. Many response bodies are not yet typed in the Bairav source, so those operations show an empty success schema. Use the examples in the guides for the calls you will use first.
This reference is generated from the Bairav source and published only for the operations listed in the portal allowlist.
Authentication
- HTTP: Bearer Auth
The access token from POST /api/auth/breakglass or POST /api/auth/refresh.
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
Bearer format: | JWT |
Contact
Bairav developer support: BTG.Support@prokraya.com