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

Rancher Nodes API

Cluster nodes registered with Rancher.

Rancher Nodes 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 Nodes. 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 1 operation across 1 path, 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}.

1 operations 1 paths 2 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://{rancher_host}/v3
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

Rancher Nodes API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (token-XXXXX:secret) (BearerAuth).

Paths & Operations 1

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

Nodes 1

Cluster nodes registered with Rancher.

GET
/nodes
List nodes
listNodes → 200

Schemas 2

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

Node
object
5 properties
NodeCollection
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rancher-nodes-api-openapi.yml Raw ↑

Other APIs Rancher publishes across the network.

Rancher Apps API
Rancher Catalogs API
Rancher Clusters API
Rancher Projects API
Rancher Roles API
Rancher Tokens API
Rancher Users API