Skip to content

API Reference

Auto-generated API reference for kubex and kubex-core, rendered from source docstrings by mkdocstrings.

Page Covers
kubex.api Api[T], create_api(), subresource accessors (LogsAccessor, ScaleAccessor, ExecAccessor, …)
kubex.client BaseClient, create_client(), HttpxClient, AioHttpClient, WebSocketConnection
kubex.configuration ClientConfiguration, kubeconfig loading, in-cluster auth, exec provider, OIDC
kubex.core exceptions, request/response models, API params, patch types, channel protocol, request builder
kubex-core base Pydantic models, marker interfaces, ResourceConfig, metadata, list/watch, subresource models

Generated K8s resource models

The generated resource models under kubex.k8s.v1_* (Pod, Deployment, Service, …) are not rendered here — there are ~666 files across 6 Kubernetes versions. See the source on GitHub or install kubex[k8s-1.35] and browse with your IDE for full type information.