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 Services ServiceStatus API

Status subresource operations for Services, used to update load balancer provisioning state and conditions.

Kubernetes Services ServiceStatus API is one of 13 APIs that Kubernetes Services 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 ServiceStatus. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, an AsyncAPI specification, and 1 JSON Schema.

This API exposes 2 operations across 1 path, 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.

2 operations 1 paths 8 schemas 1 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

Kubernetes Services ServiceStatus 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 or user bearer token.
  • clientCertificate — Client TLS certificate signed by the cluster CA.

Paths & Operations 2

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

ServiceStatus 2

Status subresource operations for Services, used to update load balancer provisioning state and conditions.

GET
/api/v1/namespaces/{namespace}/services/{name}/status
Kubernetes Services Get Service status
getNamespacedServiceStatus 2 params → 200401404
PUT
/api/v1/namespaces/{namespace}/services/{name}/status
Kubernetes Services Replace Service status
replaceNamespacedServiceStatus 2 params body → 200401404

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are ServiceSpec (17 properties), ObjectMeta (8 properties), ServicePort (6 properties), Condition (6 properties). Each schema is shown below with its type and property counts.

ServiceSpec
object
Specification of the desired behavior of a Service, defining port mappings, pod selection, service type, IP configuration, and traffic policy.
17 properties
LoadBalancerIngress
object
An ingress point for a load balancer, representing a provisioned IP address or DNS hostname assigned by the cloud provider.
3 properties
ServicePort
object
A port mapping within a Service, defining the protocol, service-facing port, and the target pod port.
6 properties 1 required
ObjectMeta
object
Standard Kubernetes object metadata.
8 properties
ServiceStatus
object
Most recently observed status of a Service, including load balancer provisioning state and ingress IP/hostname assignments.
2 properties
Service
object
A Service is an abstract way to expose an application running on a set of Pods as a network service. It provides a stable virtual IP and DNS name, decoupling c…
5 properties
Status
object
A return value for operations that do not return other objects.
4 properties
Condition
object
A condition representing a particular aspect of a resource's current state.
6 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kubernetes-services-servicestatus-api-openapi.yml Raw ↑

Other APIs Kubernetes Services publishes across the network.

Kubernetes DNS for Services and Pods
Kubernetes Services EndpointSlices API
Kubernetes Services Gateway API
Kubernetes Services GatewayClass API
Kubernetes Services GRPCRoute API
Kubernetes Services HTTPRoute API
Kubernetes Services Ingress API
Kubernetes Services IngressClass API
Kubernetes Services IngressStatus API
Kubernetes Services Namespaces API
Kubernetes Services NetworkPolicy API
Kubernetes Services Services API