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 Applications API

Manage applications and their API keys and credentials

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

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

5 operations 3 paths 6 schemas 3 GET1 POST1 PUT

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 Applications 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 5

Across 3 paths, the API surfaces 5 operations — 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Applications 5

Manage applications and their API keys and credentials

GET
/accounts/{account_id}/applications.json
List Applications for Account
listApplications 2 params → 200
POST
/accounts/{account_id}/applications.json
Create Application
createApplication 1 param body → 201422
GET
/accounts/{account_id}/applications/{id}.json
Get Application
getApplication 3 params → 200404
PUT
/accounts/{account_id}/applications/{id}.json
Update Application
updateApplication 3 params body → 200
GET
/applications/{application_id}/usage.json
Get Application Usage
getApplicationUsage 6 params → 200404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Application (9 properties), ApplicationPlan (7 properties), UsageStats (6 properties), CreateApplicationRequest (3 properties). Each schema is shown below with its type and property counts.

ApplicationPlan
object
7 properties
UpdateApplicationRequest
object
3 properties
CreateApplicationRequest
object
3 properties 2 required
UsageStats
object
6 properties
ApplicationList
object
1 property
Application
object
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

red-hat-3scale-applications-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 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
Red Hat 3scale Plans API