API Overview

    The REST API is the fundamental fabric of Kubernetes. All operations and communications between components, and external user commands are REST API calls that the API Server handles. Consequently, everything in the Kubernetes platform is treated as an API object and has a corresponding entry in the API.

    The lists the API for Kubernetes version v1.27.

    For general background information, read The Kubernetes API. describes how clients can authenticate to the Kubernetes API server, and how their requests are authorized.

    The JSON and Protobuf serialization schemas follow the same guidelines for schema changes. The following descriptions cover both formats.

    The API versioning and software versioning are indirectly related. The describes the relationship between API versioning and software versioning.

    Different API versions indicate different levels of stability and support. You can find more information about the criteria for each level in the API Changes documentation.

    Here’s a summary of each level:

      • The version names contain (for example, v1alpha1).
      • Built-in alpha API versions are disabled by default and must be explicitly enabled in the kube-apiserver configuration to be used.
      • The software may contain bugs. Enabling a feature may expose bugs.
      • The API may change in incompatible ways in a later software release without notice.
      • The software is recommended for use only in short-lived testing clusters, due to increased risk of bugs and lack of long-term support.

    • Beta:

      • The version names contain beta (for example, v2beta3).

      • Built-in beta API versions are disabled by default and must be explicitly enabled in the kube-apiserver configuration to be used (except for beta versions of APIs introduced prior to Kubernetes 1.22, which were enabled by default).

      • Built-in beta API versions have a maximum lifetime of 9 months or 3 minor releases (whichever is longer) from introduction to deprecation, and 9 months or 3 minor releases (whichever is longer) from deprecation to removal.

      • The software is well tested. Enabling a feature is considered safe.

      • The support for a feature will not be dropped, though the details may change.

      • The schema and/or semantics of objects may change in incompatible ways in a subsequent beta or stable API version. When this happens, migration instructions are provided. Adapting to a subsequent beta or stable API version may require editing or re-creating API objects, and may not be straightforward. The migration may require downtime for applications that rely on the feature.

      Note: Please try beta features and provide feedback. After the features exit beta, it may not be practical to make more changes.

    • Stable:

      • The version name is vX where X is an integer.
      • Stable API versions remain available for all future releases within a Kubernetes major version, and there are no current plans for a major version revision of Kubernetes that removes stable APIs.

    API groups make it easier to extend the Kubernetes API. The API group is specified in a REST path and in the apiVersion field of a serialized object.

    There are several API groups in Kubernetes:

    • The core (also called legacy) group is found at REST path . The core group is not specified as part of the apiVersion field, for example, apiVersion: v1.
    • The named groups are at REST path /apis/$GROUP_NAME/$VERSION and use apiVersion: $GROUP_NAME/$VERSION (for example, apiVersion: batch/v1). You can find the full list of supported API groups in .

    Certain resources and API groups are enabled by default. You can enable or disable them by setting --runtime-config on the API server. The --runtime-config flag accepts comma separated <key>[=<value>] pairs describing the runtime configuration of the API server. If the part is omitted, it is treated as if =true is specified. For example:

    • to disable batch/v1, set --runtime-config=batch/v1=false
    • to enable batch/v2alpha1, set --runtime-config=batch/v2alpha1
    • to enable a specific version of an API, such as storage.k8s.io/v1beta1/csistoragecapacities, set --runtime-config=storage.k8s.io/v1beta1/csistoragecapacities

    Note: When you enable or disable groups or resources, you need to restart the API server and controller manager to pick up the --runtime-config changes.

    Kubernetes stores its serialized state in terms of the API resources by writing them into etcd.