Reports API
Endpoints
- API Report - Inventory of all API Proxies and API Proxy Groups
- Organization API Data Model Access Report - Organization-level API and data model access report
The endpoints on this page are inventory reports: what exists and who may reach it. For consumption — how many tokens, how much cost and how much quota headroom a subject used in a period — see the Usage Reports API.
Authentication
All endpoints require authentication using a Personal API Access Token.
Permissions
| Endpoint | Backend requirement |
|---|---|
| API Report | System admin (sysAdmin) or system analyzer (sysAnalyzer) |
| Organization API Data Model Access Report | Valid API token (backend does not enforce sysAdmin / sysAnalyzer) |
Warning
The Organization report endpoint does not perform the same privilege check as the API Report endpoint in the current backend implementation. Treat this as a known behavior difference until aligned in code.
Related Documentation
- Authentication Guide - How to obtain and use API tokens
- Error Handling - Error response formats