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

Kubernetes Config API

Configuration and storage resources including ConfigMaps, Secrets, PersistentVolumes, and PersistentVolumeClaims.

Kubernetes Config 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 Config. 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 4 operations across 2 paths, and defines 8 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.

4 operations 2 paths 8 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1.32.0
Base URL
https://kubernetes.default.svc
Authentication
HTTP Bearer, Mutual TLS
Terms of Service
Resource Areas
1

Authentication & Security 2

Kubernetes Config 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 4

Across 2 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Config 4

Configuration and storage resources including ConfigMaps, Secrets, PersistentVolumes, and PersistentVolumeClaims.

GET
/api/v1/namespaces/{namespace}/configmaps
Kubernetes List ConfigMaps in a namespace
listNamespacedConfigMaps 4 params → 200401
POST
/api/v1/namespaces/{namespace}/configmaps
Kubernetes Create a ConfigMap
createNamespacedConfigMap 1 param body → 201400401
GET
/api/v1/namespaces/{namespace}/secrets
Kubernetes List Secrets in a namespace
listNamespacedSecrets 4 params → 200401
POST
/api/v1/namespaces/{namespace}/secrets
Kubernetes Create a Secret
createNamespacedSecret 1 param body → 201400401

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are ObjectMeta (10 properties), Status (6 properties), Secret (6 properties), OwnerReference (5 properties). Each schema is shown below with its type and property counts.

ObjectMeta
object
Standard Kubernetes object metadata included on all persistent resources. Contains identifying information, ownership references, and system-managed fields lik…
10 properties
OwnerReference
object
Reference to an owning resource that manages this object's lifecycle via garbage collection.
5 properties 4 required
ConfigMap
object
A ConfigMap holds non-confidential configuration data as key-value pairs. Pods can consume ConfigMaps as environment variables, command-line arguments, or conf…
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
Secret
object
A Secret stores sensitive information such as passwords, OAuth tokens, and TLS certificates. Secret data is base64-encoded and access is controlled via RBAC.
6 properties
ConfigMapList
object
A list of ConfigMaps returned by list operations.
4 properties 1 required
ListMeta
object
Metadata that all list responses include, containing pagination state and the resource version of the list.
3 properties
SecretList
object
A list of Secrets returned by list operations.
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kubernetes-config-api-openapi.yml Raw ↑

Other APIs Kubernetes publishes across the network.

Kubernetes Autoscaling API
Kubernetes Cluster API
Kubernetes Events API
Kubernetes Namespaces API
Kubernetes RBAC API
Kubernetes Workloads API