Red Hat OpenShift Clusters API
Manage OpenShift clusters across cloud providers
Red Hat OpenShift Clusters API is one of 16 APIs that Red Hat OpenShift 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, and a getting-started guide.
This API exposes 5 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 4.0.
Requests are made against a single base URL, https://api.{cluster}:6443.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Red Hat OpenShift Clusters API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (bearerAuth).
By default, every request must be authenticated.
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.
Manage OpenShift clusters across cloud providers
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Cluster (15 properties), ClusterList (5 properties), Error (5 properties), ClusterPatch (2 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 OpenShift 12
Other APIs Red Hat OpenShift publishes across the network.