# API Overview

Kubernetes API Reference Docs Overview API Groups Workloads APIs Container v1 core CronJob v1 batch Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces Status Operations Patch Status Read Status Replace Status DaemonSet v1 apps Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces Status Operations Patch Status Read Status Replace Status Deployment v1 apps Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces Status Operations Patch Status Read Status Replace Status Misc Operations Read Scale Replace Scale Patch Scale Job v1 batch Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces Status Operations Patch Status Read Status Replace Status Pod v1 core Write Operations Create Create Eviction Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces Status Operations Patch Status Read Status Replace Status Resize Operations Read Resize Patch Resize Replace Resize EphemeralContainers Operations Patch EphemeralContainers Read EphemeralContainers Replace EphemeralContainers Proxy Operations Create Connect Portforward Create Connect Proxy Create Connect Proxy Path Delete Connect Proxy Delete Connect Proxy Path Get Connect Portforward Get Connect Proxy Get Connect Proxy Path Head Connect Proxy Head Connect Proxy Path Replace Connect Proxy Replace Connect Proxy Path Misc Operations Read Log Get Connect Exec Create Connect Exec Get Connect Attach Create Connect Attach ReplicaSet v1 apps Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces Status Operations Patch Status Read Status Replace Status Misc Operations Read Scale Replace Scale Patch Scale ReplicationController v1 core Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces Status Operations Patch Status Read Status Replace Status Misc Operations Read Scale Replace Scale Patch Scale StatefulSet v1 apps Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces Status Operations Patch Status Read Status Replace Status Misc Operations Read Scale Replace Scale Patch Scale Service APIs Endpoints v1 core Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces EndpointSlice v1 discovery.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces Ingress v1 networking.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces Status Operations Patch Status Read Status Replace Status IngressClass v1 networking.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List Service v1 core Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces Status Operations Patch Status Read Status Replace Status Proxy Operations Create Connect Proxy Create Connect Proxy Path Delete Connect Proxy Delete Connect Proxy Path Get Connect Proxy Get Connect Proxy Path Head Connect Proxy Head Connect Proxy Path Replace Connect Proxy Replace Connect Proxy Path Config and Storage APIs ConfigMap v1 core Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces CSIDriver v1 storage.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List CSINode v1 storage.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List CSIStorageCapacity v1 storage.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces Secret v1 core Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces PersistentVolumeClaim v1 core Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces Status Operations Patch Status Read Status Replace Status StorageClass v1 storage.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List StorageVersionMigration v1alpha1 storagemigration.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List Status Operations Patch Status Read Status Replace Status Volume v1 core VolumeAttachment v1 storage.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List Status Operations Patch Status Read Status Replace Status VolumeAttributesClass v1 storage.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List Metadata APIs ClusterTrustBundle v1beta1 certificates.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List ControllerRevision v1 apps Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces CustomResourceDefinition v1 apiextensions.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List Status Operations Patch Status Read Status Replace Status DeviceClass v1 resource.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List DeviceTaintRule v1alpha3 resource.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List Event v1 events.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces LimitRange v1 core Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces HorizontalPodAutoscaler v2 autoscaling Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces Status Operations Patch Status Read Status Replace Status MutatingWebhookConfiguration v1 admissionregistration.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List PodTemplate v1 core Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces PodDisruptionBudget v1 policy Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces Status Operations Patch Status Read Status Replace Status PriorityClass v1 scheduling.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List ResourceClaim v1 resource.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces Status Operations Patch Status Read Status Replace Status ResourceClaimTemplate v1 resource.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces ResourceSlice v1 resource.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List ValidatingAdmissionPolicy v1 admissionregistration.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List Status Operations Patch Status Read Status Replace Status ValidatingAdmissionPolicyBinding v1 admissionregistration.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List ValidatingWebhookConfiguration v1 admissionregistration.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List Cluster APIs APIService v1 apiregistration.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List Status Operations Patch Status Read Status Replace Status Binding v1 core Write Operations Create CertificateSigningRequest v1 certificates.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List Status Operations Patch Status Read Status Replace Status ClusterRole v1 rbac.authorization.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List ClusterRoleBinding v1 rbac.authorization.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List ComponentStatus v1 core Read Operations Read List FlowSchema v1 flowcontrol.apiserver.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List Status Operations Patch Status Read Status Replace Status IPAddress v1 networking.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List Lease v1 coordination.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces LeaseCandidate v1beta1 coordination.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces LocalSubjectAccessReview v1 authorization.k8s.io Write Operations Create Namespace v1 core Write Operations Create Patch Replace Delete Read Operations Read List Watch Watch List Status Operations Patch Status Read Status Replace Status Node v1 core Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List Status Operations Patch Status Read Status Replace Status Proxy Operations Create Connect Proxy Create Connect Proxy Path Delete Connect Proxy Delete Connect Proxy Path Get Connect Proxy Get Connect Proxy Path Head Connect Proxy Head Connect Proxy Path Replace Connect Proxy Replace Connect Proxy Path PersistentVolume v1 core Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List Status Operations Patch Status Read Status Replace Status PodCertificateRequest v1alpha1 certificates.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces Status Operations Patch Status Read Status Replace Status PriorityLevelConfiguration v1 flowcontrol.apiserver.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List Status Operations Patch Status Read Status Replace Status ResourceQuota v1 core Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces Status Operations Patch Status Read Status Replace Status Role v1 rbac.authorization.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces RoleBinding v1 rbac.authorization.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces RuntimeClass v1 node.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List SelfSubjectAccessReview v1 authorization.k8s.io Write Operations Create SelfSubjectReview v1 authentication.k8s.io Write Operations Create SelfSubjectRulesReview v1 authorization.k8s.io Write Operations Create ServiceAccount v1 core Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces ServiceCIDR v1 networking.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List Status Operations Patch Status Read Status Replace Status StorageVersion v1alpha1 internal.apiserver.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List Status Operations Patch Status Read Status Replace Status StorageVersionMigration v1alpha1 storagemigration.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List Status Operations Patch Status Read Status Replace Status SubjectAccessReview v1 authorization.k8s.io Write Operations Create TokenRequest v1 authentication.k8s.io TokenReview v1 authentication.k8s.io Write Operations Create NetworkPolicy v1 networking.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces MutatingAdmissionPolicy v1beta1 admissionregistration.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List MutatingAdmissionPolicyBinding v1beta1 admissionregistration.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List DEFINITIONS APIGroup v1 meta APIResource v1 meta APIServiceCondition v1 apiregistration.k8s.io APIVersions v1 meta AWSElasticBlockStoreVolumeSource v1 core Affinity v1 core AggregationRule v1 rbac.authorization.k8s.io AllocatedDeviceStatus v1 resource.k8s.io AllocationResult v1 resource.k8s.io AppArmorProfile v1 core ApplyConfiguration v1beta1 admissionregistration.k8s.io AttachedVolume v1 core AuditAnnotation v1 admissionregistration.k8s.io AzureDiskVolumeSource v1 core AzureFilePersistentVolumeSource v1 core AzureFileVolumeSource v1 core BasicDevice v1beta1 resource.k8s.io BoundObjectReference v1 authentication.k8s.io CELDeviceSelector v1 resource.k8s.io CSINodeDriver v1 storage.k8s.io CSIPersistentVolumeSource v1 core CSIVolumeSource v1 core Capabilities v1 core CapacityRequestPolicy v1 resource.k8s.io CapacityRequestPolicyRange v1 resource.k8s.io CapacityRequirements v1 resource.k8s.io CephFSPersistentVolumeSource v1 core CephFSVolumeSource v1 core CertificateSigningRequestCondition v1 certificates.k8s.io CinderPersistentVolumeSource v1 core CinderVolumeSource v1 core ClientIPConfig v1 core ClusterTrustBundleProjection v1 core ComponentCondition v1 core Condition v1 meta ConfigMapEnvSource v1 core ConfigMapKeySelector v1 core ConfigMapNodeConfigSource v1 core ConfigMapProjection v1 core ConfigMapVolumeSource v1 core ContainerExtendedResourceRequest v1 core ContainerImage v1 core ContainerPort v1 core ContainerResizePolicy v1 core ContainerResourceMetricSource v2 autoscaling ContainerResourceMetricStatus v2 autoscaling ContainerRestartRule v1 core ContainerRestartRuleOnExitCodes v1 core ContainerState v1 core ContainerStateRunning v1 core ContainerStateTerminated v1 core ContainerStateWaiting v1 core ContainerUser v1 core Counter v1 resource.k8s.io CounterSet v1 resource.k8s.io CrossVersionObjectReference v2 autoscaling CustomResourceColumnDefinition v1 apiextensions.k8s.io CustomResourceConversion v1 apiextensions.k8s.io CustomResourceDefinitionCondition v1 apiextensions.k8s.io CustomResourceDefinitionNames v1 apiextensions.k8s.io CustomResourceDefinitionVersion v1 apiextensions.k8s.io CustomResourceSubresourceScale v1 apiextensions.k8s.io CustomResourceSubresourceStatus v1 apiextensions.k8s.io CustomResourceSubresources v1 apiextensions.k8s.io CustomResourceValidation v1 apiextensions.k8s.io DaemonEndpoint v1 core DaemonSetCondition v1 apps DaemonSetUpdateStrategy v1 apps DeleteOptions v1 meta DeploymentCondition v1 apps Device v1 resource.k8s.io DeviceAllocationConfiguration v1 resource.k8s.io DeviceAllocationResult v1 resource.k8s.io DeviceAttribute v1 resource.k8s.io DeviceCapacity v1 resource.k8s.io DeviceClaim v1 resource.k8s.io DeviceClaimConfiguration v1 resource.k8s.io DeviceClassConfiguration v1 resource.k8s.io DeviceConstraint v1 resource.k8s.io DeviceCounterConsumption v1 resource.k8s.io DeviceRequest v1 resource.k8s.io DeviceRequestAllocationResult v1 resource.k8s.io DeviceSelector v1 resource.k8s.io DeviceSubRequest v1 resource.k8s.io DeviceTaint v1 resource.k8s.io DeviceTaintSelector v1alpha3 resource.k8s.io DeviceToleration v1 resource.k8s.io DownwardAPIProjection v1 core DownwardAPIVolumeFile v1 core DownwardAPIVolumeSource v1 core EmptyDirVolumeSource v1 core Endpoint v1 discovery.k8s.io EndpointAddress v1 core EndpointConditions v1 discovery.k8s.io EndpointHints v1 discovery.k8s.io EndpointPort v1 core EndpointSubset v1 core EnvFromSource v1 core EnvVar v1 core EnvVarSource v1 core EphemeralContainer v1 core EphemeralVolumeSource v1 core EventSeries v1 events.k8s.io EventSource v1 core Eviction v1 policy ExactDeviceRequest v1 resource.k8s.io ExecAction v1 core ExemptPriorityLevelConfiguration v1 flowcontrol.apiserver.k8s.io ExpressionWarning v1 admissionregistration.k8s.io ExternalDocumentation v1 apiextensions.k8s.io ExternalMetricSource v2 autoscaling ExternalMetricStatus v2 autoscaling FCVolumeSource v1 core FieldSelectorAttributes v1 authorization.k8s.io FieldSelectorRequirement v1 meta FieldsV1 v1 meta FileKeySelector v1 core FlexPersistentVolumeSource v1 core FlexVolumeSource v1 core FlockerVolumeSource v1 core FlowDistinguisherMethod v1 flowcontrol.apiserver.k8s.io FlowSchemaCondition v1 flowcontrol.apiserver.k8s.io ForNode v1 discovery.k8s.io ForZone v1 discovery.k8s.io GCEPersistentDiskVolumeSource v1 core GRPCAction v1 core GitRepoVolumeSource v1 core GlusterfsPersistentVolumeSource v1 core GlusterfsVolumeSource v1 core GroupSubject v1 flowcontrol.apiserver.k8s.io GroupVersionForDiscovery v1 meta GroupVersionResource v1alpha1 storagemigration.k8s.io HPAScalingPolicy v2 autoscaling HPAScalingRules v2 autoscaling HTTPGetAction v1 core HTTPHeader v1 core HTTPIngressPath v1 networking.k8s.io HTTPIngressRuleValue v1 networking.k8s.io HorizontalPodAutoscalerBehavior v2 autoscaling HorizontalPodAutoscalerCondition v2 autoscaling HostAlias v1 core HostIP v1 core HostPathVolumeSource v1 core IPBlock v1 networking.k8s.io ISCSIPersistentVolumeSource v1 core ISCSIVolumeSource v1 core ImageVolumeSource v1 core IngressBackend v1 networking.k8s.io IngressClassParametersReference v1 networking.k8s.io IngressLoadBalancerIngress v1 networking.k8s.io IngressLoadBalancerStatus v1 networking.k8s.io IngressPortStatus v1 networking.k8s.io IngressRule v1 networking.k8s.io IngressServiceBackend v1 networking.k8s.io IngressTLS v1 networking.k8s.io JSON v1 apiextensions.k8s.io JSONPatch v1beta1 admissionregistration.k8s.io JSONSchemaProps v1 apiextensions.k8s.io JSONSchemaPropsOrArray v1 apiextensions.k8s.io JSONSchemaPropsOrBool v1 apiextensions.k8s.io JobCondition v1 batch JobTemplateSpec v1 batch KeyToPath v1 core LabelSelector v1 meta LabelSelectorAttributes v1 authorization.k8s.io LabelSelectorRequirement v1 meta Lifecycle v1 core LifecycleHandler v1 core LimitRangeItem v1 core LimitResponse v1 flowcontrol.apiserver.k8s.io LimitedPriorityLevelConfiguration v1 flowcontrol.apiserver.k8s.io LinuxContainerUser v1 core ListMeta v1 meta LoadBalancerIngress v1 core LoadBalancerStatus v1 core LocalObjectReference v1 core LocalVolumeSource v1 core ManagedFieldsEntry v1 meta MatchCondition v1 admissionregistration.k8s.io MatchResources v1 admissionregistration.k8s.io MetricIdentifier v2 autoscaling MetricSpec v2 autoscaling MetricStatus v2 autoscaling MetricTarget v2 autoscaling MetricValueStatus v2 autoscaling MicroTime v1 meta MigrationCondition v1alpha1 storagemigration.k8s.io ModifyVolumeStatus v1 core MutatingWebhook v1 admissionregistration.k8s.io Mutation v1beta1 admissionregistration.k8s.io NFSVolumeSource v1 core NamedRuleWithOperations v1 admissionregistration.k8s.io NamespaceCondition v1 core NetworkDeviceData v1 resource.k8s.io NetworkPolicyEgressRule v1 networking.k8s.io NetworkPolicyIngressRule v1 networking.k8s.io NetworkPolicyPeer v1 networking.k8s.io NetworkPolicyPort v1 networking.k8s.io NodeAddress v1 core NodeAffinity v1 core NodeCondition v1 core NodeConfigSource v1 core NodeConfigStatus v1 core NodeDaemonEndpoints v1 core NodeFeatures v1 core NodeRuntimeHandler v1 core NodeRuntimeHandlerFeatures v1 core NodeSelector v1 core NodeSelectorRequirement v1 core NodeSelectorTerm v1 core NodeSwapStatus v1 core NodeSystemInfo v1 core NonResourceAttributes v1 authorization.k8s.io NonResourcePolicyRule v1 flowcontrol.apiserver.k8s.io NonResourceRule v1 authorization.k8s.io ObjectFieldSelector v1 core ObjectMeta v1 meta ObjectMetricSource v2 autoscaling ObjectMetricStatus v2 autoscaling ObjectReference v1 core OpaqueDeviceConfiguration v1 resource.k8s.io Overhead v1 node.k8s.io OwnerReference v1 meta ParamKind v1 admissionregistration.k8s.io ParamRef v1 admissionregistration.k8s.io ParentReference v1 networking.k8s.io Patch v1 meta PersistentVolumeClaimCondition v1 core PersistentVolumeClaimTemplate v1 core PersistentVolumeClaimVolumeSource v1 core PhotonPersistentDiskVolumeSource v1 core PodAffinity v1 core PodAffinityTerm v1 core PodAntiAffinity v1 core PodCertificateProjection v1 core PodCondition v1 core PodDNSConfig v1 core PodDNSConfigOption v1 core PodExtendedResourceClaimStatus v1 core PodFailurePolicy v1 batch PodFailurePolicyOnExitCodesRequirement v1 batch PodFailurePolicyOnPodConditionsPattern v1 batch PodFailurePolicyRule v1 batch PodIP v1 core PodOS v1 core PodReadinessGate v1 core PodResourceClaim v1 core PodSchedulingGate v1 core PodSecurityContext v1 core PodsMetricSource v2 autoscaling PodsMetricStatus v2 autoscaling PolicyRule v1 rbac.authorization.k8s.io PolicyRulesWithSubjects v1 flowcontrol.apiserver.k8s.io PortStatus v1 core PortworxVolumeSource v1 core Preconditions v1 meta PreferredSchedulingTerm v1 core PriorityLevelConfigurationCondition v1 flowcontrol.apiserver.k8s.io PriorityLevelConfigurationReference v1 flowcontrol.apiserver.k8s.io Probe v1 core ProjectedVolumeSource v1 core Quantity resource core QueuingConfiguration v1 flowcontrol.apiserver.k8s.io QuobyteVolumeSource v1 core RBDPersistentVolumeSource v1 core RBDVolumeSource v1 core ReplicaSetCondition v1 apps ReplicationControllerCondition v1 core ResourceAttributes v1 authorization.k8s.io ResourceClaim v1 core ResourceClaimConsumerReference v1 resource.k8s.io ResourceFieldSelector v1 core ResourceHealth v1 core ResourceMetricSource v2 autoscaling ResourceMetricStatus v2 autoscaling ResourcePolicyRule v1 flowcontrol.apiserver.k8s.io ResourcePool v1 resource.k8s.io ResourceRequirements v1 core ResourceRule v1 authorization.k8s.io ResourceStatus v1 core RoleRef v1 rbac.authorization.k8s.io RollingUpdateStatefulSetStrategy v1 apps RuleWithOperations v1 admissionregistration.k8s.io SELinuxOptions v1 core Scale v1 autoscaling ScaleIOPersistentVolumeSource v1 core ScaleIOVolumeSource v1 core Scheduling v1 node.k8s.io ScopeSelector v1 core ScopedResourceSelectorRequirement v1 core SeccompProfile v1 core SecretEnvSource v1 core SecretKeySelector v1 core SecretProjection v1 core SecretReference v1 core SecretVolumeSource v1 core SecurityContext v1 core SelectableField v1 apiextensions.k8s.io ServerAddressByClientCIDR v1 meta ServerStorageVersion v1alpha1 internal.apiserver.k8s.io ServiceAccountSubject v1 flowcontrol.apiserver.k8s.io ServiceAccountTokenProjection v1 core ServiceBackendPort v1 networking.k8s.io ServicePort v1 core ServiceReference v1 admissionregistration.k8s.io SessionAffinityConfig v1 core SleepAction v1 core StatefulSetCondition v1 apps StatefulSetOrdinals v1 apps StatefulSetPersistentVolumeClaimRetentionPolicy v1 apps StatefulSetUpdateStrategy v1 apps Status v1 meta StatusCause v1 meta StatusDetails v1 meta StorageOSPersistentVolumeSource v1 core StorageOSVolumeSource v1 core StorageVersionCondition v1alpha1 internal.apiserver.k8s.io Subject v1 flowcontrol.apiserver.k8s.io SubjectRulesReviewStatus v1 authorization.k8s.io SuccessPolicy v1 batch SuccessPolicyRule v1 batch Sysctl v1 core TCPSocketAction v1 core Taint v1 core Time v1 meta Toleration v1 core TopologySelectorLabelRequirement v1 core TopologySelectorTerm v1 core TopologySpreadConstraint v1 core TypeChecking v1 admissionregistration.k8s.io TypedLocalObjectReference v1 core TypedObjectReference v1 core UncountedTerminatedPods v1 batch UserInfo v1 authentication.k8s.io UserSubject v1 flowcontrol.apiserver.k8s.io ValidatingWebhook v1 admissionregistration.k8s.io Validation v1 admissionregistration.k8s.io ValidationRule v1 apiextensions.k8s.io Variable v1 admissionregistration.k8s.io VolumeAttachmentSource v1 storage.k8s.io VolumeDevice v1 core VolumeError v1 storage.k8s.io VolumeMount v1 core VolumeNodeAffinity v1 core VolumeNodeResources v1 storage.k8s.io VolumeProjection v1 core VolumeResourceRequirements v1 core VsphereVirtualDiskVolumeSource v1 core WatchEvent v1 meta WebhookClientConfig v1 admissionregistration.k8s.io WebhookConversion v1 apiextensions.k8s.io WeightedPodAffinityTerm v1 core WindowsSecurityContextOptions v1 core OLD API VERSIONS AllocatedDeviceStatus v1beta2 resource.k8s.io AllocatedDeviceStatus v1beta1 resource.k8s.io AllocationResult v1beta2 resource.k8s.io AllocationResult v1beta1 resource.k8s.io ApplyConfiguration v1alpha1 admissionregistration.k8s.io CELDeviceSelector v1beta2 resource.k8s.io CELDeviceSelector v1beta1 resource.k8s.io CELDeviceSelector v1alpha3 resource.k8s.io CapacityRequestPolicy v1beta2 resource.k8s.io CapacityRequestPolicy v1beta1 resource.k8s.io CapacityRequestPolicyRange v1beta2 resource.k8s.io CapacityRequestPolicyRange v1beta1 resource.k8s.io CapacityRequirements v1beta2 resource.k8s.io CapacityRequirements v1beta1 resource.k8s.io ClusterTrustBundle v1alpha1 certificates.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List Counter v1beta2 resource.k8s.io Counter v1beta1 resource.k8s.io CounterSet v1beta2 resource.k8s.io CounterSet v1beta1 resource.k8s.io CrossVersionObjectReference v1 autoscaling Device v1beta2 resource.k8s.io Device v1beta1 resource.k8s.io DeviceAllocationConfiguration v1beta2 resource.k8s.io DeviceAllocationConfiguration v1beta1 resource.k8s.io DeviceAllocationResult v1beta2 resource.k8s.io DeviceAllocationResult v1beta1 resource.k8s.io DeviceAttribute v1beta2 resource.k8s.io DeviceAttribute v1beta1 resource.k8s.io DeviceCapacity v1beta2 resource.k8s.io DeviceCapacity v1beta1 resource.k8s.io DeviceClaim v1beta2 resource.k8s.io DeviceClaim v1beta1 resource.k8s.io DeviceClaimConfiguration v1beta2 resource.k8s.io DeviceClaimConfiguration v1beta1 resource.k8s.io DeviceClass v1beta2 resource.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List DeviceClass v1beta1 resource.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List DeviceClassConfiguration v1beta2 resource.k8s.io DeviceClassConfiguration v1beta1 resource.k8s.io DeviceConstraint v1beta2 resource.k8s.io DeviceConstraint v1beta1 resource.k8s.io DeviceCounterConsumption v1beta2 resource.k8s.io DeviceCounterConsumption v1beta1 resource.k8s.io DeviceRequest v1beta2 resource.k8s.io DeviceRequest v1beta1 resource.k8s.io DeviceRequestAllocationResult v1beta2 resource.k8s.io DeviceRequestAllocationResult v1beta1 resource.k8s.io DeviceSelector v1beta2 resource.k8s.io DeviceSelector v1beta1 resource.k8s.io DeviceSelector v1alpha3 resource.k8s.io DeviceSubRequest v1beta2 resource.k8s.io DeviceSubRequest v1beta1 resource.k8s.io DeviceTaint v1beta2 resource.k8s.io DeviceTaint v1beta1 resource.k8s.io DeviceTaint v1alpha3 resource.k8s.io DeviceToleration v1beta2 resource.k8s.io DeviceToleration v1beta1 resource.k8s.io EndpointPort v1 discovery.k8s.io Event v1 core Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces EventSeries v1 core ExactDeviceRequest v1beta2 resource.k8s.io HorizontalPodAutoscaler v1 autoscaling Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces Status Operations Patch Status Read Status Replace Status IPAddress v1beta1 networking.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List JSONPatch v1alpha1 admissionregistration.k8s.io LeaseCandidate v1alpha2 coordination.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces MatchCondition v1beta1 admissionregistration.k8s.io MatchCondition v1alpha1 admissionregistration.k8s.io MatchResources v1beta1 admissionregistration.k8s.io MatchResources v1alpha1 admissionregistration.k8s.io MutatingAdmissionPolicy v1alpha1 admissionregistration.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List MutatingAdmissionPolicyBinding v1alpha1 admissionregistration.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List Mutation v1alpha1 admissionregistration.k8s.io NamedRuleWithOperations v1beta1 admissionregistration.k8s.io NamedRuleWithOperations v1alpha1 admissionregistration.k8s.io NetworkDeviceData v1beta2 resource.k8s.io NetworkDeviceData v1beta1 resource.k8s.io OpaqueDeviceConfiguration v1beta2 resource.k8s.io OpaqueDeviceConfiguration v1beta1 resource.k8s.io ParamKind v1beta1 admissionregistration.k8s.io ParamKind v1alpha1 admissionregistration.k8s.io ParamRef v1beta1 admissionregistration.k8s.io ParamRef v1alpha1 admissionregistration.k8s.io ParentReference v1beta1 networking.k8s.io ResourceClaim v1 resource.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces Status Operations Patch Status Read Status Replace Status ResourceClaim v1beta2 resource.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces Status Operations Patch Status Read Status Replace Status ResourceClaim v1beta1 resource.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces Status Operations Patch Status Read Status Replace Status ResourceClaimConsumerReference v1beta2 resource.k8s.io ResourceClaimConsumerReference v1beta1 resource.k8s.io ResourceClaimTemplate v1beta2 resource.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces ResourceClaimTemplate v1beta1 resource.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List List All Namespaces Watch Watch List Watch List All Namespaces ResourcePool v1beta2 resource.k8s.io ResourcePool v1beta1 resource.k8s.io ResourceSlice v1beta2 resource.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List ResourceSlice v1beta1 resource.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List ServiceCIDR v1beta1 networking.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List Status Operations Patch Status Read Status Replace Status ServiceReference v1 apiextensions.k8s.io ServiceReference v1 apiregistration.k8s.io Subject v1 rbac.authorization.k8s.io TokenRequest v1 storage.k8s.io Variable v1beta1 admissionregistration.k8s.io Variable v1alpha1 admissionregistration.k8s.io VolumeAttributesClass v1beta1 storage.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List VolumeAttributesClass v1alpha1 storage.k8s.io Write Operations Create Patch Replace Delete Delete Collection Read Operations Read List Watch Watch List WebhookClientConfig v1 apiextensions.k8s.io Copyright 2016-2025 The Kubernetes Authors. Generated at: 2025-08-30 21:35:23 (CST) API Version: v1.34.0 Switch / API Overview Welcome to the Kubernetes API. You can use the Kubernetes API to read and write Kubernetes resource objects via a Kubernetes API endpoint. Resource Categories This is a high-level overview of the basic types of resources provide by the Kubernetes API and their primary functions. Workloads are objects you use to manage and run your containers on the cluster. Discovery & LB resources are objects you use to "stitch" your workloads together into an externally accessible, load-balanced Service. Config & Storage resources are objects you use to inject initialization data into your applications, and to persist data that is external to your container. Cluster resources objects define how the cluster itself is configured; these are typically used only by cluster operators. Metadata resources are objects you use to configure the behavior of other resources within the cluster, such as HorizontalPodAutoscaler for scaling workloads. Resource Objects Resource objects typically have 3 components: Resource ObjectMeta: This is metadata about the resource, such as its name, type, api version, annotations, and labels. This contains fields that maybe updated both by the end user and the system (e.g. annotations). ResourceSpec: This is defined by the user and describes the desired state of system. Fill this in when creating or updating an object. ResourceStatus: This is filled in by the server and reports the current state of the system. In most cases, users don't need to change this. Resource Operations Most resources provide the following Operations: Create Create operations will create the resource in the storage backend. After a resource is create the system will apply the desired state. Update Updates come in 2 forms: Replace and Patch: Replace: Replacing a resource object will update the resource by replacing the existing spec with the provided one. For read-then-write operations this is safe because an optimistic lock failure will occur if the resource was modified between the read and write. Note: The ResourceStatus will be ignored by the system and will not be updated. To update the status, one must invoke the specific status update operation. Note: Replacing a resource object may not result immediately in changes being propagated to downstream objects. For instance replacing a ConfigMap or Secret resource will not result in all Pods seeing the changes unless the Pods are restarted out of band. Patch: Patch will apply a change to a specific field. How the change is merged is defined per field. Lists may either be replaced or merged. Merging lists will not preserve ordering. Patches will never cause optimistic locking failures, and the last write will win. Patches are recommended when the full state is not read before an update, or when failing on optimistic locking is undesirable. When patching complex types, arrays and maps, how the patch is applied is defined on a per-field basis and may either replace the field's current value, or merge the contents into the current value. Read Reads come in 3 forms: Get, List and Watch: Get: Get will retrieve a specific resource object by name. List: List will retrieve all resource objects of a specific type within a namespace, and the results can be restricted to resources matching a selector query. List All Namespaces: Like List but retrieves resources across all namespaces. Watch: Watch will stream results for an object(s) as it is updated. Similar to a callback, watch is used to respond to resource changes. Delete Delete will delete a resource. Depending on the specific resource, child objects may or may not be garbage collected by the server. See notes on specific resource objects for details. Additional Operations Resources may define additional operations specific to that resource type. Rollback: Rollback a PodTemplate to a previous version. Only available for some resource types. Read / Write Scale: Read or Update the number of replicas for the given resource. Only available for some resource types. Read / Write Status: Read or Update the Status for a resource object. The Status can only changed through these update operations. API Groups The API Groups and their versions are summarized in the following table. GroupVersions admissionregistration.k8s.iov1, v1beta1, v1alpha1 apiextensions.k8s.iov1 apiregistration.k8s.iov1 appsv1 authentication.k8s.iov1 authorization.k8s.iov1 autoscalingv2, v1 batchv1 certificates.k8s.iov1, v1beta1, v1alpha1 coordination.k8s.iov1, v1beta1, v1alpha2 corev1 discovery.k8s.iov1 events.k8s.iov1 flowcontrol.apiserver.k8s.iov1 internal.apiserver.k8s.iov1alpha1 networking.k8s.iov1, v1beta1 node.k8s.iov1 policyv1 rbac.authorization.k8s.iov1 resource.k8s.iov1, v1beta2, v1beta1, v1alpha3 scheduling.k8s.iov1 storage.k8s.iov1, v1beta1, v1alpha1 storagemigration.k8s.iov1alpha1 Workloads Workloads resources are responsible for managing and running your containers on the cluster. Containers are created by Controllers through Pods. Pods run Containers and provide environmental dependencies such as shared or persistent storage Volumes and Configuration or Secret data injected into the container. The most common Controllers are: Deployments for stateless persistent apps (e.g. HTTP servers). StatefulSets for stateful persistent apps (e.g. databases). Jobs for run-to-completion apps (e.g. batch Jobs). Container v1 core show example Container Config to run nginx (must be embedded in a PodSpec to run). name: nginx # Run the nginx:1.14 image image: nginx:1.14 GroupVersionKind corev1Container Warning:Containers are only ever created within the context of a Pod. This is usually done using a Controller. See Controllers: Deployment, Job, or StatefulSet Appears In: PodSpec [core/v1] FieldDescription argsstring arrayArguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell commandstring arrayEntrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell envEnvVar arraypatch strategy: mergepatch merge key: nameList of environment variables to set in the container. Cannot be updated. envFromEnvFromSource arrayList of sources to populate environment variables in the container. The keys defined within a source may consist of any printable ASCII characters except '='. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. imagestringContainer image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. imagePullPolicystringImage pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images lifecycleLifecycleActions that the management system should take in response to container lifecycle events. Cannot be updated. livenessProbeProbePeriodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes namestringName of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. portsContainerPort arraypatch strategy: mergepatch merge key: containerPortList of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated. readinessProbeProbePeriodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes resizePolicyContainerResizePolicy arrayResources resize policy for the container. resourcesResourceRequirementsCompute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ restartPolicystringRestartPolicy defines the restart behavior of individual containers in a pod. This overrides the pod-level restart policy. When this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. Additionally, setting the RestartPolicy as "Always" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy "Always" will be shut down. This lifecycle differs from normal init containers and is often referred to as a "sidecar" container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the