Rancher Clusters API
Downstream Kubernetes clusters managed by Rancher.
Rancher Clusters API is one of 8 APIs that Rancher publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 6 JSON Schema definitions.
Tagged areas include Clusters. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, a JSON-LD context, and 6 JSON Schemas.
This API exposes 4 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 1.0.
Requests are made against 2 base URLs: https://{rancher_host}/v3, https://{rancher_host}/k8s/clusters/{cluster_id}.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Rancher Clusters API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (token-XXXXX:secret) (BearerAuth).
Paths & Operations 4
Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Downstream Kubernetes clusters managed by Rancher.
Schemas 2
The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Cluster (6 properties), ClusterCollection (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 Rancher 7
Other APIs Rancher publishes across the network.