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 Namespaces API

The Namespaces API from Kubernetes — 2 operation(s) for namespaces.

Kubernetes Namespaces 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 Namespaces. 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 5 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.

5 operations 2 paths 8 schemas 1 DELETE2 GET1 POST1 PUT

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 Namespaces 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 5

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

Namespaces 5
GET
/api/v1/namespaces/{namespace}/services
Kubernetes List services in a namespace
listNamespacedServices 5 params → 200401
POST
/api/v1/namespaces/{namespace}/services
Kubernetes Create a service
createNamespacedService 1 param body → 201400401
GET
/api/v1/namespaces/{namespace}/services/{name}
Kubernetes Get a service
getNamespacedService 2 params → 200401404
PUT
/api/v1/namespaces/{namespace}/services/{name}
Kubernetes Replace a service
replaceNamespacedService 2 params body → 200401404
DELETE
/api/v1/namespaces/{namespace}/services/{name}
Kubernetes Delete a service
deleteNamespacedService 2 params → 200401404

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), ServicePort (5 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
ServiceList
object
A list of services returned by list operations.
4 properties 1 required
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
ServiceSpec
object
Specification for the desired behavior of a service, including the port mappings, pod selector, and service type.
5 properties
ListMeta
object
Metadata that all list responses include, containing pagination state and the resource version of the list.
3 properties
ServicePort
object
A port that a service exposes, mapping from a service port to a target port.
5 properties 1 required
Service
object
A Service is an abstraction that defines a logical set of pods and a policy for accessing them. Services enable decoupling between consumer and producer pods t…
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kubernetes-namespaces-api-openapi.yml Raw ↑

Other APIs Kubernetes publishes across the network.

Kubernetes Autoscaling API
Kubernetes Cluster API
Kubernetes Config API
Kubernetes Events API
Kubernetes RBAC API
Kubernetes Workloads API