Red Hat Clusters API
Operations for provisioning, managing, and retrieving OpenShift clusters across cloud providers.
Red Hat Clusters API is one of 75 APIs that Red Hat publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Clusters. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, a changelog, and a GitHub repository.
This API exposes 5 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 2.6.
Requests are made against a single base URL, https://ansible-platform.example.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Red Hat Clusters API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (bearerAuth).
By default, every request must be authenticated.
bearerAuth— OAuth 2.0 Bearer token for authenticating API requests to the automation controller.
Paths & Operations 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Operations for provisioning, managing, and retrieving OpenShift clusters across cloud providers.
Schemas 3
The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Cluster (13 properties), Error (5 properties), ClusterList (5 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 12
Other APIs Red Hat publishes across the network.