Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Red Hat 3scale Services API

Manage API services and their settings

Red Hat 3scale Services 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 Services. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 4 paths, and defines 5 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.

4 operations 4 paths 5 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1
Base URL
https://su1.3scale.net
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Red Hat 3scale Services 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 4

Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

Services 4

Manage API services and their settings

GET
/services.json
List Services
listServices 3 params → 200
GET
/services/{id}.json
Get Service
getService 2 params → 200404
GET
/services/{service_id}/usage.json
Get Service Usage
getServiceUsage 8 params → 200404
GET
/services/{service_id}/top_applications.json
Get Top Applications by Usage
getTopApplications 4 params → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are UsageStats (6 properties), Service (6 properties), TopApplication (2 properties), TopApplicationsList (1 property). Each schema is shown below with its type and property counts.

Service
object
6 properties
ServiceList
object
1 property
UsageStats
object
6 properties
TopApplicationsList
object
1 property
TopApplication
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

red-hat-3scale-services-api-openapi.yml Raw ↑

Other APIs Red Hat 3scale publishes across the network.

Red Hat 3scale Webhooks
Red Hat 3scale Toolbox CLI
Red Hat 3scale Accounts API
Red Hat 3scale Applications API
Red Hat 3scale Authorization API
Red Hat 3scale Configuration API
Red Hat 3scale DNS API
Red Hat 3scale Health API
Red Hat 3scale Initialization API
Red Hat 3scale Invoices API
Red Hat 3scale OAuth API
Red Hat 3scale Payment Transactions API