Kubernetes Cluster API is one of 7 APIs that Kubernetes publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
This API exposes 1 JSON Schema definition.
Tagged areas include Cluster. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, an AsyncAPI specification, and 1 JSON Schema.
This API exposes
7 operations
across 4 paths,
and defines 12 schemas.
It is described by OpenAPI 3.1.0, at version v1.32.0.
Requests are made against a single base URL, https://kubernetes.default.svc.
7 operations4 paths12 schemas1 DELETE4 GET1 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Kubernetes Cluster API declares
2 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (bearerAuth).
It requires mutual TLS (clientCertificate).
By default, every request must be authenticated.
bearerAuth — Kubernetes service account token or user token issued by the cluster's authentication provider. Include in the Authorization header as 'Bearer '.
clientCertificate — Client certificate authentication using a TLS certificate issued by the cluster's certificate authority.
Paths & Operations 7
Across 4 paths, the API surfaces 7 operations — 1 DELETE, 4 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Cluster 7
Cluster-level resources including Namespaces, Nodes, ServiceAccounts, and RBAC resources for cluster administration.
GET
/api/v1/namespaces
Kubernetes List namespaces
listNamespaces6 params→ 200401
POST
/api/v1/namespaces
Kubernetes Create a namespace
createNamespacebody→ 201400401409
GET
/api/v1/namespaces/{name}
Kubernetes Get a namespace
getNamespace1 param→ 200401404
PUT
/api/v1/namespaces/{name}
Kubernetes Replace a namespace
replaceNamespace1 parambody→ 200401404
DELETE
/api/v1/namespaces/{name}
Kubernetes Delete a namespace
deleteNamespace1 param→ 200401404
GET
/api/v1/nodes
Kubernetes List nodes
listNodes4 params→ 200401
GET
/api/v1/nodes/{name}
Kubernetes Get a node
getNode1 param→ 200401404
Schemas 12
The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are ObjectMeta (10 properties), Status (6 properties), Node (5 properties), Namespace (5 properties). Each schema is shown below with its type and property counts.
NodeList
object
A list of nodes returned by list operations.
4 properties1 required
Namespace
object
A Namespace provides a mechanism for isolating groups of resources within a single cluster. Names of resources need to be unique within a namespace, but not ac…
5 properties
Status
object
Status is a return value for calls that don't return other objects. It is used to convey error messages, reasons, and codes for both success and failure respon…
6 properties
ListMeta
object
Metadata that all list responses include, containing pagination state and the resource version of the list.
3 properties
Taint
object
A taint applied to a node that repels pods without a matching toleration. Used for dedicated nodes, nodes with special hardware, or node evictions.
3 properties2 required
NodeCondition
object
Condition describing the current state of a node component.
4 properties2 required
ObjectMeta
object
Standard Kubernetes object metadata included on all persistent resources. Contains identifying information, ownership references, and system-managed fields lik…
10 properties
Node
object
A Node is a worker machine in Kubernetes. Each node contains the services necessary to run pods and is managed by the control plane. Nodes have resources inclu…
5 properties
NamespaceList
object
A list of namespaces returned by list operations.
4 properties1 required
NodeStatus
object
Most recently observed status of the node including capacity, allocatable resources, conditions, and system info.
3 properties
NodeSpec
object
Specification of a node, including taints and configuration sources.
4 properties
OwnerReference
object
Reference to an owning resource that manages this object's lifecycle via garbage collection.
5 properties4 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
