Pod [core/v1] - Workloads <strong>api</strong>s | <strong>api</strong> reference

Specification
api endpoints

Description: Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts.
Type: object

Specification

Property Type Description

Property	Type	Description
`.apiVersion`	`string`	apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`.kind`	`string`	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`.metadata`	`ObjectMeta meta/v1`	Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`.spec`	`object`	PodSpec is a description of a pod.
`.status`	`object`	PodStatus represents information about the status of a pod. Status may trail the actual state of a system, especially if the node that hosts the pod cannot contact the control plane.

.apiVersion

string

apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

.kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

.metadata

ObjectMeta meta/v1

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

.spec

object

PodSpec is a description of a pod.

.status

object

PodStatus represents information about the status of a pod. Status may trail the actual state of a system, especially if the node that hosts the pod cannot contact the control plane.

.spec

Description

PodSpec is a description of a pod.

Type

object

Required

containers

Property Type Description

Property	Type	Description
`activeDeadlineSeconds`	`integer`	Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer.
`affinity`	`Affinity core/v1`	If specified, the pod’s scheduling constraints
`automountServiceAccountToken`	`boolean`	AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.
`containers`	`array (Container core/v1)`	List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated.
`dnsConfig`	`PodDNSConfig core/v1`	Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.
`dnsPolicy`	`string`	Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.
`enableServiceLinks`	`boolean`	EnableServiceLinks indicates whether information about services should be injected into pod’s environment variables, matching the syntax of Docker links. Optional: Defaults to true.
`ephemeralContainers`	`array (EphemeralContainer core/v1)`	List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod’s ephemeralcontainers subresource. This field is alpha-level and is only honored by servers that enable the EphemeralContainers feature.
`hostAliases`	`array (HostAlias core/v1)`	HostAliases is an optional list of hosts and IPs that will be injected into the pod’s hosts file if specified. This is only valid for non-hostNetwork pods.
`hostIPC`	`boolean`	Use the host’s ipc namespace. Optional: Default to false.
`hostNetwork`	`boolean`	Host networking requested for this pod. Use the host’s network namespace. If this option is set, the ports that will be used must be specified. Default to false.
`hostPID`	`boolean`	Use the host’s pid namespace. Optional: Default to false.
`hostname`	`string`	Specifies the hostname of the Pod If not specified, the pod’s hostname will be set to a system-defined value.
`imagePullSecrets`	`array (LocalObjectReference core/v1)`	ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod
`initContainers`	`array (Container core/v1)`	List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
`nodeName`	`string`	NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.
`nodeSelector`	`object (string)`	NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
`overhead`	`object (Quantity api/resource)`	Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.16, and is only honored by servers that enable the PodOverhead feature.
`preemptionPolicy`	`string`	PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate.
`priority`	`integer`	The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority.
`priorityClassName`	`string`	If specified, indicates the pod’s priority. "system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default.
`readinessGates`	`array (PodReadinessGate core/v1)`	If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/0007-pod-ready%2B%2B.md
`restartPolicy`	`string`	Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy
`runtimeClassName`	`string`	RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md This is a beta feature as of Kubernetes v1.14.
`schedulerName`	`string`	If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.
`securityContext`	`PodSecurityContext core/v1`	SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.
`serviceAccount`	`string`	DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.
`serviceAccountName`	`string`	ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
`setHostnameAsFQDN`	`boolean`	If true the pod’s hostname will be configured as the pod’s FQDN, rather than the leaf name (the default). In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters to FQDN. If a pod does not have FQDN, this has no effect. Default to false.
`shareProcessNamespace`	`boolean`	Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false.
`subdomain`	`string`	If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". If not specified, the pod will not have a domainname at all.
`terminationGracePeriodSeconds`	`integer`	Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.
`tolerations`	`array (Toleration core/v1)`	If specified, the pod’s tolerations.
`topologySpreadConstraints`	`array (TopologySpreadConstraint core/v1)`	TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed.
`volumes`	`array (Volume core/v1)`	List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes

activeDeadlineSeconds

integer

Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer.

affinity

Affinity core/v1

If specified, the pod’s scheduling constraints

automountServiceAccountToken

boolean

AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.

containers

array (Container core/v1)

List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated.

dnsConfig

PodDNSConfig core/v1

Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.

dnsPolicy

string

Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.

enableServiceLinks

boolean

EnableServiceLinks indicates whether information about services should be injected into pod’s environment variables, matching the syntax of Docker links. Optional: Defaults to true.

ephemeralContainers

array (EphemeralContainer core/v1)

List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod’s ephemeralcontainers subresource. This field is alpha-level and is only honored by servers that enable the EphemeralContainers feature.

hostAliases

array (HostAlias core/v1)

HostAliases is an optional list of hosts and IPs that will be injected into the pod’s hosts file if specified. This is only valid for non-hostNetwork pods.

hostIPC

boolean

Use the host’s ipc namespace. Optional: Default to false.

hostNetwork

boolean

Host networking requested for this pod. Use the host’s network namespace. If this option is set, the ports that will be used must be specified. Default to false.

hostPID

boolean

Use the host’s pid namespace. Optional: Default to false.

hostname

string

Specifies the hostname of the Pod If not specified, the pod’s hostname will be set to a system-defined value.

imagePullSecrets

array (LocalObjectReference core/v1)

ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod

initContainers

array (Container core/v1)

List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/

nodeName

string

NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.

nodeSelector

object (string)

NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/

overhead

object (Quantity api/resource)

Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.16, and is only honored by servers that enable the PodOverhead feature.

preemptionPolicy

string

PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate.

priority

integer

The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority.

priorityClassName

string

If specified, indicates the pod’s priority. "system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default.

readinessGates

array (PodReadinessGate core/v1)

If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/0007-pod-ready%2B%2B.md

restartPolicy

string

Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy

runtimeClassName

string

RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md This is a beta feature as of Kubernetes v1.14.

schedulerName

string

If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.

securityContext

PodSecurityContext core/v1

SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.

serviceAccount

string

DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.

serviceAccountName

string

ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/

setHostnameAsFQDN

boolean

If true the pod’s hostname will be configured as the pod’s FQDN, rather than the leaf name (the default). In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters to FQDN. If a pod does not have FQDN, this has no effect. Default to false.

shareProcessNamespace

boolean

Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false.

subdomain

string

If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". If not specified, the pod will not have a domainname at all.

terminationGracePeriodSeconds

integer

Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.

tolerations

array (Toleration core/v1)

If specified, the pod’s tolerations.

topologySpreadConstraints

array (TopologySpreadConstraint core/v1)

TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed.

volumes

array (Volume core/v1)

List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes

.status

Description: PodStatus represents information about the status of a pod. Status may trail the actual state of a system, especially if the node that hosts the pod cannot contact the control plane.
Type: object

Property Type Description

Property	Type	Description
`conditions`	`array (PodCondition core/v1)`	Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
`containerStatuses`	`array`	The list has one entry per container in the manifest. Each entry is currently the output of `docker inspect`. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status
`containerStatuses[]`	`object`	ContainerStatus contains details for the current status of this container.
`ephemeralContainerStatuses`	`array`	Status for any ephemeral containers that have run in this pod. This field is alpha-level and is only populated by servers that enable the EphemeralContainers feature.
`ephemeralContainerStatuses[]`	`object`	ContainerStatus contains details for the current status of this container.
`hostIP`	`string`	IP address of the host to which the pod is assigned. Empty if not yet scheduled.
`initContainerStatuses`	`array`	The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status
`initContainerStatuses[]`	`object`	ContainerStatus contains details for the current status of this container.
`message`	`string`	A human readable message indicating details about why the pod is in this condition.
`nominatedNodeName`	`string`	nominatedNodeName is set only when this pod preempts other pods on the node, but it cannot be scheduled right away as preemption victims receive their graceful termination periods. This field does not guarantee that the pod will be scheduled on this node. Scheduler may decide to place the pod elsewhere if other nodes become available sooner. Scheduler may also decide to give the resources on this node to a higher priority pod that is created after preemption. As a result, this field may be different than PodSpec.nodeName when the pod is scheduled.
`phase`	`string`	The phase of a Pod is a simple, high-level summary of where the Pod is in its lifecycle. The conditions array, the reason and message fields, and the individual container status arrays contain more detail about the pod’s status. There are five possible phase values: Pending: The pod has been accepted by the Kubernetes system, but one or more of the container images has not been created. This includes time before being scheduled as well as time spent downloading images over the network, which could take a while. Running: The pod has been bound to a node, and all of the containers have been created. At least one container is still running, or is in the process of starting or restarting. Succeeded: All containers in the pod have terminated in success, and will not be restarted. Failed: All containers in the pod have terminated, and at least one container has terminated in failure. The container either exited with non-zero status or was terminated by the system. Unknown: For some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase
`podIP`	`string`	IP address allocated to the pod. Routable at least within the cluster. Empty if not yet allocated.
`podIPs`	`array (PodIP core/v1)`	podIPs holds the IP addresses allocated to the pod. If this field is specified, the 0th entry must match the podIP field. Pods may be allocated at most 1 value for each of IPv4 and IPv6. This list is empty if no IPs have been allocated yet.
`qosClass`	`string`	The Quality of Service (QOS) classification assigned to the pod based on resource requirements See PodQOSClass type for available QOS classes More info: https://git.k8s.io/community/contributors/design-proposals/node/resource-qos.md
`reason`	`string`	A brief CamelCase message indicating details about why the pod is in this state. e.g. 'Evicted'
`startTime`	`Time meta/v1`	RFC 3339 date and time at which the object was acknowledged by the Kubelet. This is before the Kubelet pulled the container image(s) for the pod.

conditions

array (PodCondition core/v1)

Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

containerStatuses

array

The list has one entry per container in the manifest. Each entry is currently the output of docker inspect. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status

containerStatuses[]

object

ContainerStatus contains details for the current status of this container.

ephemeralContainerStatuses

array

Status for any ephemeral containers that have run in this pod. This field is alpha-level and is only populated by servers that enable the EphemeralContainers feature.

ephemeralContainerStatuses[]

object

ContainerStatus contains details for the current status of this container.

hostIP

string

IP address of the host to which the pod is assigned. Empty if not yet scheduled.

initContainerStatuses

array

The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status

initContainerStatuses[]

object

ContainerStatus contains details for the current status of this container.

message

string

A human readable message indicating details about why the pod is in this condition.

nominatedNodeName

string

nominatedNodeName is set only when this pod preempts other pods on the node, but it cannot be scheduled right away as preemption victims receive their graceful termination periods. This field does not guarantee that the pod will be scheduled on this node. Scheduler may decide to place the pod elsewhere if other nodes become available sooner. Scheduler may also decide to give the resources on this node to a higher priority pod that is created after preemption. As a result, this field may be different than PodSpec.nodeName when the pod is scheduled.

phase

string

The phase of a Pod is a simple, high-level summary of where the Pod is in its lifecycle. The conditions array, the reason and message fields, and the individual container status arrays contain more detail about the pod’s status. There are five possible phase values:

Pending: The pod has been accepted by the Kubernetes system, but one or more of the container images has not been created. This includes time before being scheduled as well as time spent downloading images over the network, which could take a while. Running: The pod has been bound to a node, and all of the containers have been created. At least one container is still running, or is in the process of starting or restarting. Succeeded: All containers in the pod have terminated in success, and will not be restarted. Failed: All containers in the pod have terminated, and at least one container has terminated in failure. The container either exited with non-zero status or was terminated by the system. Unknown: For some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod.

More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase

podIP

string

IP address allocated to the pod. Routable at least within the cluster. Empty if not yet allocated.

podIPs

array (PodIP core/v1)

podIPs holds the IP addresses allocated to the pod. If this field is specified, the 0th entry must match the podIP field. Pods may be allocated at most 1 value for each of IPv4 and IPv6. This list is empty if no IPs have been allocated yet.

qosClass

string

The Quality of Service (QOS) classification assigned to the pod based on resource requirements See PodQOSClass type for available QOS classes More info: https://git.k8s.io/community/contributors/design-proposals/node/resource-qos.md

reason

string

A brief CamelCase message indicating details about why the pod is in this state. e.g. 'Evicted'

startTime

Time meta/v1

RFC 3339 date and time at which the object was acknowledged by the Kubelet. This is before the Kubelet pulled the container image(s) for the pod.

.status.containerStatuses

Description: The list has one entry per container in the manifest. Each entry is currently the output of docker inspect. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status
Type: array

.status.containerStatuses[]

Description

ContainerStatus contains details for the current status of this container.

Type

object

Required

name
ready
restartCount
image
imageID

Property Type Description

Property	Type	Description
`containerID`	`string`	Container’s ID in the format 'docker://<container_id>'.
`image`	`string`	The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images
`imageID`	`string`	ImageID of the container’s image.
`lastState`	`ContainerState core/v1`	Details about the container’s last termination condition.
`name`	`string`	This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated.
`ready`	`boolean`	Specifies whether the container has passed its readiness probe.
`restartCount`	`integer`	The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. But those containers are subject to garbage collection. This value will get capped at 5 by GC.
`started`	`boolean`	Specifies whether the container has passed its startup probe. Initialized as false, becomes true after startupProbe is considered successful. Resets to false when the container is restarted, or if kubelet loses state temporarily. Is always true when no startupProbe is defined.
`state`	`ContainerState core/v1`	Details about the container’s current condition.

containerID

string

Container’s ID in the format 'docker://<container_id>'.

image

string

The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images

imageID

string

ImageID of the container’s image.

lastState

ContainerState core/v1

Details about the container’s last termination condition.

name

string

This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated.

ready

boolean

Specifies whether the container has passed its readiness probe.

restartCount

integer

The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. But those containers are subject to garbage collection. This value will get capped at 5 by GC.

started

boolean

Specifies whether the container has passed its startup probe. Initialized as false, becomes true after startupProbe is considered successful. Resets to false when the container is restarted, or if kubelet loses state temporarily. Is always true when no startupProbe is defined.

state

ContainerState core/v1

Details about the container’s current condition.

.status.ephemeralContainerStatuses

Description: Status for any ephemeral containers that have run in this pod. This field is alpha-level and is only populated by servers that enable the EphemeralContainers feature.
Type: array

.status.ephemeralContainerStatuses[]

Description

ContainerStatus contains details for the current status of this container.

Type

object

Required

name
ready
restartCount
image
imageID

Property Type Description

Property	Type	Description
`containerID`	`string`	Container’s ID in the format 'docker://<container_id>'.
`image`	`string`	The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images
`imageID`	`string`	ImageID of the container’s image.
`lastState`	`ContainerState core/v1`	Details about the container’s last termination condition.
`name`	`string`	This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated.
`ready`	`boolean`	Specifies whether the container has passed its readiness probe.
`restartCount`	`integer`	The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. But those containers are subject to garbage collection. This value will get capped at 5 by GC.
`started`	`boolean`	Specifies whether the container has passed its startup probe. Initialized as false, becomes true after startupProbe is considered successful. Resets to false when the container is restarted, or if kubelet loses state temporarily. Is always true when no startupProbe is defined.
`state`	`ContainerState core/v1`	Details about the container’s current condition.

containerID

string

Container’s ID in the format 'docker://<container_id>'.

image

string

The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images

imageID

string

ImageID of the container’s image.

lastState

ContainerState core/v1

Details about the container’s last termination condition.

name

string

This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated.

ready

boolean

Specifies whether the container has passed its readiness probe.

restartCount

integer

started

boolean

state

ContainerState core/v1

Details about the container’s current condition.

.status.initContainerStatuses

Description: The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status
Type: array

.status.initContainerStatuses[]

Description

ContainerStatus contains details for the current status of this container.

Type

object

Required

name
ready
restartCount
image
imageID

Property Type Description

Property	Type	Description
`containerID`	`string`	Container’s ID in the format 'docker://<container_id>'.
`image`	`string`	The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images
`imageID`	`string`	ImageID of the container’s image.
`lastState`	`ContainerState core/v1`	Details about the container’s last termination condition.
`name`	`string`	This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated.
`ready`	`boolean`	Specifies whether the container has passed its readiness probe.
`restartCount`	`integer`	The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. But those containers are subject to garbage collection. This value will get capped at 5 by GC.
`started`	`boolean`	Specifies whether the container has passed its startup probe. Initialized as false, becomes true after startupProbe is considered successful. Resets to false when the container is restarted, or if kubelet loses state temporarily. Is always true when no startupProbe is defined.
`state`	`ContainerState core/v1`	Details about the container’s current condition.

containerID

string

Container’s ID in the format 'docker://<container_id>'.

image

string

The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images

imageID

string

ImageID of the container’s image.

lastState

ContainerState core/v1

Details about the container’s last termination condition.

name

string

This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated.

ready

boolean

Specifies whether the container has passed its readiness probe.

restartCount

integer

started

boolean

state

ContainerState core/v1

Details about the container’s current condition.

api endpoints

The following api endpoints are available:

/api/v1/pods
- GET: list or watch objects of kind Pod
/api/v1/namespaces/{namespace}/pods
- DELETE: delete collection of Pod
- GET: list or watch objects of kind Pod
- POST: create a Pod
/api/v1/namespaces/{namespace}/pods/{name}
- DELETE: delete a Pod
- GET: read the specified Pod
- PATCH: partially update the specified Pod
- PUT: replace the specified Pod
/api/v1/namespaces/{namespace}/pods/{name}/log
- GET: read log of the specified Pod
/api/v1/namespaces/{namespace}/pods/{name}/exec
- GET: connect GET requests to exec of Pod
- POST: connect POST requests to exec of Pod
/api/v1/namespaces/{namespace}/pods/{name}/proxy
- DELETE: connect DELETE requests to proxy of Pod
- GET: connect GET requests to proxy of Pod
- HEAD: connect HEAD requests to proxy of Pod
- OPTIONS: connect OPTIONS requests to proxy of Pod
- PATCH: connect PATCH requests to proxy of Pod
- POST: connect POST requests to proxy of Pod
- PUT: connect PUT requests to proxy of Pod
/api/v1/namespaces/{namespace}/pods/{name}/attach
- GET: connect GET requests to attach of Pod
- POST: connect POST requests to attach of Pod
/api/v1/namespaces/{namespace}/pods/{name}/status
- GET: read status of the specified Pod
- PATCH: partially update status of the specified Pod
- PUT: replace status of the specified Pod
/api/v1/namespaces/{namespace}/pods/{name}/binding
- POST: create binding of a Pod
/api/v1/namespaces/{namespace}/pods/{name}/eviction
- POST: create eviction of a Pod
/api/v1/namespaces/{namespace}/pods/{name}/portforward
- GET: connect GET requests to portforward of Pod
- POST: connect POST requests to portforward of Pod
/api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
- DELETE: connect DELETE requests to proxy of Pod
- GET: connect GET requests to proxy of Pod
- HEAD: connect HEAD requests to proxy of Pod
- OPTIONS: connect OPTIONS requests to proxy of Pod
- PATCH: connect PATCH requests to proxy of Pod
- POST: connect POST requests to proxy of Pod
- PUT: connect PUT requests to proxy of Pod

/api/v1/pods

Table 1. Global guery parameters
Parameter	Type	Description
`allowWatchBookmarks`	`boolean`	allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue`	`string`	The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector`	`string`	A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector`	`string`	A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit`	`integer`	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty`	`string`	If 'true', then the output is pretty printed.
`resourceVersion`	`string`	resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch`	`string`	resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds`	`integer`	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch`	`boolean`	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

HTTP method: GET
Description: list or watch objects of kind Pod

Table 2. HTTP responses
HTTP code	Reponse body
200 - OK	`PodList core/v1`
401 - Unauthorized	Empty

/api/v1/namespaces/{namespace}/pods

Table 3. Global path parameters
Parameter	Type	Description
`namespace`	`string`	object name and auth scope, such as for teams and projects

Table 4. Global guery parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: DELETE
Description: delete collection of Pod

Table 5. Query parameters
Parameter	Type	Description
`continue`	`string`	The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector`	`string`	A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds`	`integer`	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector`	`string`	A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit`	`integer`	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents`	`boolean`	Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy`	`string`	Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
`resourceVersion`	`string`	resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch`	`string`	resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds`	`integer`	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

Table 6. Body parameters
Parameter	Type	Description
`body`	`DeleteOptions meta/v1`

Table 7. HTTP responses
HTTP code	Reponse body
200 - OK	`Status meta/v1`
401 - Unauthorized	Empty

HTTP method: GET
Description: list or watch objects of kind Pod

Table 8. Query parameters
Parameter	Type	Description
`allowWatchBookmarks`	`boolean`	allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue`	`string`	The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector`	`string`	A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector`	`string`	A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit`	`integer`	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion`	`string`	resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch`	`string`	resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds`	`integer`	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch`	`boolean`	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Table 9. HTTP responses
HTTP code	Reponse body
200 - OK	`PodList core/v1`
401 - Unauthorized	Empty

HTTP method: POST
Description: create a Pod

Table 10. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager`	`string`	fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

Table 11. Body parameters
Parameter	Type	Description
`body`	`Pod core/v1`

Table 12. HTTP responses
HTTP code	Reponse body
200 - OK	`Pod core/v1`
201 - Created	`Pod core/v1`
202 - Accepted	`Pod core/v1`
401 - Unauthorized	Empty

/api/v1/namespaces/{namespace}/pods/{name}

Table 13. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the Pod
`namespace`	`string`	object name and auth scope, such as for teams and projects

Table 14. Global guery parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: DELETE
Description: delete a Pod

Table 15. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds`	`integer`	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents`	`boolean`	Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy`	`string`	Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

Table 16. Body parameters
Parameter	Type	Description
`body`	`DeleteOptions meta/v1`

Table 17. HTTP responses
HTTP code	Reponse body
200 - OK	`Pod core/v1`
202 - Accepted	`Pod core/v1`
401 - Unauthorized	Empty

HTTP method: GET
Description: read the specified Pod

Table 18. Query parameters
Parameter	Type	Description
`exact`	`boolean`	Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18.
`export`	`boolean`	Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18.

Table 19. HTTP responses
HTTP code	Reponse body
200 - OK	`Pod core/v1`
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update the specified Pod

Table 20. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager`	`string`	fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force`	`boolean`	Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

Table 21. Body parameters
Parameter	Type	Description
`body`	`Patch meta/v1`

Table 22. HTTP responses
HTTP code	Reponse body
200 - OK	`Pod core/v1`
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace the specified Pod

Table 23. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager`	`string`	fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

Table 24. Body parameters
Parameter	Type	Description
`body`	`Pod core/v1`

Table 25. HTTP responses
HTTP code	Reponse body
200 - OK	`Pod core/v1`
201 - Created	`Pod core/v1`
401 - Unauthorized	Empty

/api/v1/namespaces/{namespace}/pods/{name}/log

Table 26. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the Pod
`namespace`	`string`	object name and auth scope, such as for teams and projects

Table 27. Global guery parameters
Parameter	Type	Description
`container`	`string`	The container for which to stream logs. Defaults to only container if there is one container in the pod.
`follow`	`boolean`	Follow the log stream of the pod. Defaults to false.
`insecureSkipTLSVerifyBackend`	`boolean`	insecureSkipTLSVerifyBackend indicates that the apiserver should not confirm the validity of the serving certificate of the backend it is connecting to. This will make the HTTPS connection between the apiserver and the backend insecure. This means the apiserver cannot verify the log data it is receiving came from the real kubelet. If the kubelet is configured to verify the apiserver's TLS credentials, it does not mean the connection to the real kubelet is vulnerable to a man in the middle attack (e.g. an attacker could not intercept the actual log data coming from the real kubelet).
`limitBytes`	`integer`	If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit.
`pretty`	`string`	If 'true', then the output is pretty printed.
`previous`	`boolean`	Return previous terminated container logs. Defaults to false.
`sinceSeconds`	`integer`	A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified.
`tailLines`	`integer`	If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime
`timestamps`	`boolean`	If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false.

HTTP method: GET
Description: read log of the specified Pod

Table 28. HTTP responses
HTTP code	Reponse body
200 - OK	`string`
401 - Unauthorized	Empty

/api/v1/namespaces/{namespace}/pods/{name}/exec

Table 29. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the PodExecOptions
`namespace`	`string`	object name and auth scope, such as for teams and projects

Table 30. Global guery parameters
Parameter	Type	Description
`command`	`string`	Command is the remote command to execute. argv array. Not executed within a shell.
`container`	`string`	Container in which to execute the command. Defaults to only container if there is only one container in the pod.
`stderr`	`boolean`	Redirect the standard error stream of the pod for this call. Defaults to true.
`stdin`	`boolean`	Redirect the standard input stream of the pod for this call. Defaults to false.
`stdout`	`boolean`	Redirect the standard output stream of the pod for this call. Defaults to true.
`tty`	`boolean`	TTY if true indicates that a tty will be allocated for the exec call. Defaults to false.

HTTP method: GET
Description: connect GET requests to exec of Pod

Table 31. HTTP responses
HTTP code	Reponse body
200 - OK	`string`
401 - Unauthorized	Empty

HTTP method: POST
Description: connect POST requests to exec of Pod

Table 32. HTTP responses
HTTP code	Reponse body
200 - OK	`string`
401 - Unauthorized	Empty

/api/v1/namespaces/{namespace}/pods/{name}/proxy

Table 33. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the PodProxyOptions
`namespace`	`string`	object name and auth scope, such as for teams and projects

Table 34. Global guery parameters
Parameter	Type	Description
`path`	`string`	Path is the URL path to use for the current proxy request to pod.

HTTP method: DELETE
Description: connect DELETE requests to proxy of Pod

Table 35. HTTP responses
HTTP code	Reponse body
200 - OK	`string`
401 - Unauthorized	Empty

HTTP method: GET
Description: connect GET requests to proxy of Pod

Table 36. HTTP responses
HTTP code	Reponse body
200 - OK	`string`
401 - Unauthorized	Empty

HTTP method: HEAD
Description: connect HEAD requests to proxy of Pod

Table 37. HTTP responses
HTTP code	Reponse body
200 - OK	`string`
401 - Unauthorized	Empty

HTTP method: OPTIONS
Description: connect OPTIONS requests to proxy of Pod

Table 38. HTTP responses
HTTP code	Reponse body
200 - OK	`string`
401 - Unauthorized	Empty

HTTP method: PATCH
Description: connect PATCH requests to proxy of Pod

Table 39. HTTP responses
HTTP code	Reponse body
200 - OK	`string`
401 - Unauthorized	Empty

HTTP method: POST
Description: connect POST requests to proxy of Pod

Table 40. HTTP responses
HTTP code	Reponse body
200 - OK	`string`
401 - Unauthorized	Empty

HTTP method: PUT
Description: connect PUT requests to proxy of Pod

Table 41. HTTP responses
HTTP code	Reponse body
200 - OK	`string`
401 - Unauthorized	Empty

/api/v1/namespaces/{namespace}/pods/{name}/attach

Table 42. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the PodAttachOptions
`namespace`	`string`	object name and auth scope, such as for teams and projects

Table 43. Global guery parameters
Parameter	Type	Description
`container`	`string`	The container in which to execute the command. Defaults to only container if there is only one container in the pod.
`stderr`	`boolean`	Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true.
`stdin`	`boolean`	Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false.
`stdout`	`boolean`	Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true.
`tty`	`boolean`	TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false.

HTTP method: GET
Description: connect GET requests to attach of Pod

Table 44. HTTP responses
HTTP code	Reponse body
200 - OK	`string`
401 - Unauthorized	Empty

HTTP method: POST
Description: connect POST requests to attach of Pod

Table 45. HTTP responses
HTTP code	Reponse body
200 - OK	`string`
401 - Unauthorized	Empty

/api/v1/namespaces/{namespace}/pods/{name}/status

Table 46. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the Pod
`namespace`	`string`	object name and auth scope, such as for teams and projects

Table 47. Global guery parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: GET
Description: read status of the specified Pod

Table 48. HTTP responses
HTTP code	Reponse body
200 - OK	`Pod core/v1`
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update status of the specified Pod

Table 49. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager`	`string`	fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force`	`boolean`	Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

Table 50. Body parameters
Parameter	Type	Description
`body`	`Patch meta/v1`

Table 51. HTTP responses
HTTP code	Reponse body
200 - OK	`Pod core/v1`
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace status of the specified Pod

Table 52. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager`	`string`	fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

Table 53. Body parameters
Parameter	Type	Description
`body`	`Pod core/v1`

Table 54. HTTP responses
HTTP code	Reponse body
200 - OK	`Pod core/v1`
201 - Created	`Pod core/v1`
401 - Unauthorized	Empty

/api/v1/namespaces/{namespace}/pods/{name}/binding

Table 55. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the Binding
`namespace`	`string`	object name and auth scope, such as for teams and projects

Table 56. Global guery parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager`	`string`	fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: POST
Description: create binding of a Pod

Table 57. Body parameters
Parameter	Type	Description
`body`	`Binding core/v1`

Table 58. HTTP responses
HTTP code	Reponse body
200 - OK	`Binding core/v1`
201 - Created	`Binding core/v1`
202 - Accepted	`Binding core/v1`
401 - Unauthorized	Empty

/api/v1/namespaces/{namespace}/pods/{name}/eviction

Table 59. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the Eviction
`namespace`	`string`	object name and auth scope, such as for teams and projects

Table 60. Global guery parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager`	`string`	fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: POST
Description: create eviction of a Pod

Table 61. Body parameters
Parameter	Type	Description
`body`	`Eviction policy/v1beta1`

Table 62. HTTP responses
HTTP code	Reponse body
200 - OK	`Eviction policy/v1beta1`
201 - Created	`Eviction policy/v1beta1`
202 - Accepted	`Eviction policy/v1beta1`
401 - Unauthorized	Empty

/api/v1/namespaces/{namespace}/pods/{name}/portforward

Table 63. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the PodPortForwardOptions
`namespace`	`string`	object name and auth scope, such as for teams and projects

Table 64. Global guery parameters
Parameter	Type	Description
`ports`	`integer`	List of ports to forward Required when using WebSockets

HTTP method: GET
Description: connect GET requests to portforward of Pod

Table 65. HTTP responses
HTTP code	Reponse body
200 - OK	`string`
401 - Unauthorized	Empty

HTTP method: POST
Description: connect POST requests to portforward of Pod

Table 66. HTTP responses
HTTP code	Reponse body
200 - OK	`string`
401 - Unauthorized	Empty

/api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}

Table 67. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the PodProxyOptions
`namespace`	`string`	object name and auth scope, such as for teams and projects
`path`	`string`	path to the resource

Table 68. Global guery parameters
Parameter	Type	Description
`path`	`string`	Path is the URL path to use for the current proxy request to pod.

HTTP method: DELETE
Description: connect DELETE requests to proxy of Pod

Table 69. HTTP responses
HTTP code	Reponse body
200 - OK	`string`
401 - Unauthorized	Empty

HTTP method: GET
Description: connect GET requests to proxy of Pod

Table 70. HTTP responses
HTTP code	Reponse body
200 - OK	`string`
401 - Unauthorized	Empty

HTTP method: HEAD
Description: connect HEAD requests to proxy of Pod

Table 71. HTTP responses
HTTP code	Reponse body
200 - OK	`string`
401 - Unauthorized	Empty

HTTP method: OPTIONS
Description: connect OPTIONS requests to proxy of Pod

Table 72. HTTP responses
HTTP code	Reponse body
200 - OK	`string`
401 - Unauthorized	Empty

HTTP method: PATCH
Description: connect PATCH requests to proxy of Pod

Table 73. HTTP responses
HTTP code	Reponse body
200 - OK	`string`
401 - Unauthorized	Empty

HTTP method: POST
Description: connect POST requests to proxy of Pod

Table 74. HTTP responses
HTTP code	Reponse body
200 - OK	`string`
401 - Unauthorized	Empty

HTTP method: PUT
Description: connect PUT requests to proxy of Pod

Table 75. HTTP responses
HTTP code	Reponse body
200 - OK	`string`
401 - Unauthorized	Empty