Red Hat 3scale Reporting API
Report API usage back to 3scale for analytics and rate limiting
Red Hat 3scale Reporting API is one of 15 APIs that Red Hat 3scale publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Reporting. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 2 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 1.
Requests are made against a single base URL, https://{domain}-admin.3scale.net/admin/api.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Red Hat 3scale Reporting API declares
1 security scheme
for authenticating requests.
An API key is passed in the query as access_token (provider_key).
By default, every request must be authenticated.
Paths & Operations 2
Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Report API usage back to 3scale for analytics and rate limiting
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are UsageReport (6 properties), AuthorizeResponse (3 properties), AuthorizeErrorResponse (3 properties), ReportRequest (3 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Red Hat 3scale 12
Other APIs Red Hat 3scale publishes across the network.