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 Operations

Most resources provide the following Operations:

Create:

Create operations will create the resource in the storage backend. After a resource is created 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.


WORKLOADS

Worloads 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:



Container v1 core

Container Config to run nginx (must be embedded in a PodSpec to run).


name: nginx
# Run the nginx:1.10 image
image: nginx:1.10

Container Config to run nginx (must be embedded in a PodSpec to run).


name: nginx
# Run the nginx:1.10 image
image: nginx:1.10
Group Version Kind
Core v1 Container

A single application container that you want to run within a pod.

Field Description
args
string array
Arguments to the entrypoint. The docker 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands
command
string array
Entrypoint array. Not executed within a shell. The docker 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands
env
EnvVar array
List of environment variables to set in the container. Cannot be updated.
envFrom
EnvFromSource array
List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. 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.
image
string
Docker image name. More info: http://kubernetes.io/docs/user-guide/images
imagePullPolicy
string
Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/images#updating-images
lifecycle
Lifecycle
Actions that the management system should take in response to container lifecycle events. Cannot be updated.
livenessProbe
Probe
Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes
name
string
Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
ports
ContainerPort array
List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. 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. Cannot be updated.
readinessProbe
Probe
Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes
resources
ResourceRequirements
Compute Resources required by this container. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#resources
securityContext
SecurityContext
Security options the pod should run with. More info: http://releases.k8s.io/HEAD/docs/design/security_context.md
stdin
boolean
Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
stdinOnce
boolean
Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
terminationMessagePath
string
Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.
terminationMessagePolicy
string
Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
tty
boolean
Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
volumeMounts
VolumeMount array
Pod volumes to mount into the container's filesystem. Cannot be updated.
workingDir
string
Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.

ContainerStatus v1 core

Field Description
containerID
string
Container's ID in the format 'docker://'. More info: http://kubernetes.io/docs/concepts/containers/container-environment-variables/#container-information
image
string
The image the container is running. More info: http://kubernetes.io/docs/user-guide/images
imageID
string
ImageID of the container's image.
lastState
ContainerState
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.
state
ContainerState
Details about the container's current condition.

CronJob v2alpha1 batch

Group Version Kind
batch v2alpha1 CronJob

CronJob represents the configuration of a single cron job.

Field 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: http://releases.k8s.io/HEAD/docs/devel/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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec
CronJobSpec
Spec is a structure defining the expected behavior of a job, including the schedule. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
status
CronJobStatus
Status is a structure describing current status of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

CronJobSpec v2alpha1 batch

Field Description
concurrencyPolicy
string
ConcurrencyPolicy specifies how to treat concurrent executions of a Job.
failedJobsHistoryLimit
integer
The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified.
jobTemplate
JobTemplateSpec
JobTemplate is the object that describes the job that will be created when executing a CronJob.
schedule
string
Schedule contains the schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
startingDeadlineSeconds
integer
Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones.
successfulJobsHistoryLimit
integer
The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified.
suspend
boolean
Suspend flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.

CronJobStatus v2alpha1 batch

Field Description
active
ObjectReference array
Active holds pointers to currently running jobs.
lastScheduleTime
Time
LastScheduleTime keeps information of when was the last time the job was successfully scheduled.

CronJobList v2alpha1 batch

Field 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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items
CronJob array
Items is the list of CronJob.
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ListMeta
Standard list metadata More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

Write Operations

See supported operations below...

Create

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

create a CronJob

HTTP Request

POST /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
CronJob

Response

Code Description
200
CronJob
OK

Replace

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

replace the specified CronJob

HTTP Request

PUT /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}

Path Parameters

Parameter Description
name name of the CronJob
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
CronJob

Response

Code Description
200
CronJob
OK

Patch

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

partially update the specified CronJob

HTTP Request

PATCH /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}

Path Parameters

Parameter Description
name name of the CronJob
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Patch

Response

Code Description
200
CronJob
OK

Delete

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

delete a CronJob

HTTP Request

DELETE /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}

Path Parameters

Parameter Description
name name of the CronJob
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
gracePeriodSeconds 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 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 Whether and how garbage collection will be performed. Defaults to Default. Either this field or OrphanDependents may be set, but not both.

Body Parameters

Parameter Description
body
DeleteOptions

Response

Code Description
200
Status
OK

Delete Collection

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

delete collection of CronJob

HTTP Request

DELETE /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
Status
OK

Read Operations

See supported operations below...

Read

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

read the specified CronJob

HTTP Request

GET /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}

Path Parameters

Parameter Description
name name of the CronJob
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
exact Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
export Should this value be exported. Export strips fields that a user can not specify.

Response

Code Description
200
CronJob
OK

List

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

list or watch objects of kind CronJob

HTTP Request

GET /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
CronJobList
OK

List All Namespaces

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

list or watch objects of kind CronJob

HTTP Request

GET /apis/batch/v2alpha1/cronjobs

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
CronJobList
OK

Watch

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch changes to an object of kind CronJob

HTTP Request

GET /apis/batch/v2alpha1/watch/namespaces/{namespace}/cronjobs/{name}

Path Parameters

Parameter Description
name name of the CronJob
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Watch List

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch individual changes to a list of CronJob

HTTP Request

GET /apis/batch/v2alpha1/watch/namespaces/{namespace}/cronjobs

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Watch List All Namespaces

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch individual changes to a list of CronJob

HTTP Request

GET /apis/batch/v2alpha1/watch/cronjobs

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Status Operations

See supported operations below...

Patch Status

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

partially update status of the specified CronJob

HTTP Request

PATCH /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}/status

Path Parameters

Parameter Description
name name of the CronJob
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Patch

Response

Code Description
200
CronJob
OK

Read Status

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

read status of the specified CronJob

HTTP Request

GET /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}/status

Path Parameters

Parameter Description
name name of the CronJob
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Response

Code Description
200
CronJob
OK

Replace Status

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

replace status of the specified CronJob

HTTP Request

PUT /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}/status

Path Parameters

Parameter Description
name name of the CronJob
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
CronJob

Response

Code Description
200
CronJob
OK

DaemonSet v1beta1 extensions

DaemonSet Config to print the hostname on each Node in the cluster every 10 seconds.


apiVersion: extensions/v1beta1
kind: DaemonSet
metadata:
  # Unique key of the DaemonSet instance
  name: daemonset-example
spec:
  template:
    metadata:
      labels:
        app: daemonset-example
    spec:
      containers:
      # This container is run once on each Node in the cluster
      - name: daemonset-example
        image: ubuntu:trusty
        command:
        - /bin/sh
        args:
        - -c
        # This script is run through `sh -c <script>`
        - >-
          while [ true ]; do
          echo "DaemonSet running on $(hostname)" ;
          sleep 10 ;
          done

DaemonSet Config to print the hostname on each Node in the cluster every 10 seconds.


apiVersion: extensions/v1beta1
kind: DaemonSet
metadata:
  # Unique key of the DaemonSet instance
  name: daemonset-example
spec:
  template:
    metadata:
      labels:
        app: daemonset-example
    spec:
      containers:
      # This container is run once on each Node in the cluster
      - name: daemonset-example
        image: ubuntu:trusty
        command:
        - /bin/sh
        args:
        - -c
        # This script is run through `sh -c <script>`
        - >-
          while [ true ]; do
          echo "DaemonSet running on $(hostname)" ;
          sleep 10 ;
          done
Group Version Kind
extensions v1beta1 DaemonSet

DaemonSet represents the configuration of a daemon set.

Field 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: http://releases.k8s.io/HEAD/docs/devel/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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec
DaemonSetSpec
Spec defines the desired behavior of this daemon set. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
status
DaemonSetStatus
Status is the current status of this daemon set. This data may be out of date by some window of time. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

DaemonSetSpec v1beta1 extensions

Field Description
minReadySeconds
integer
MinReadySeconds minimum number of seconds for which a newly created DaemonSet pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready).
selector
LabelSelector
Selector is a label query over pods that are managed by the daemon set. Must match in order to be controlled. If empty, defaulted to labels on Pod template. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
template
PodTemplateSpec
Template is the object that describes the pod that will be created. The DaemonSet will create exactly one copy of this pod on every node that matches the template's node selector (or on every node if no node selector is specified). More info: http://kubernetes.io/docs/user-guide/replication-controller#pod-template
templateGeneration
integer
A sequence number representing a specific generation of the template. Populated by the system. It can be set only during the creation.
updateStrategy
DaemonSetUpdateStrategy
UpdateStrategy to replace existing DaemonSet pods with new pods.

DaemonSetStatus v1beta1 extensions

Field Description
currentNumberScheduled
integer
CurrentNumberScheduled is the number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. More info: http://releases.k8s.io/HEAD/docs/admin/daemons.md
desiredNumberScheduled
integer
DesiredNumberScheduled is the total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: http://releases.k8s.io/HEAD/docs/admin/daemons.md
numberAvailable
integer
NumberAvailable is the number of nodes that should be running the daemon pod and have one or more of the daemon pod running and available (ready for at least minReadySeconds)
numberMisscheduled
integer
NumberMisscheduled is the number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info: http://releases.k8s.io/HEAD/docs/admin/daemons.md
numberReady
integer
NumberReady is the number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready.
numberUnavailable
integer
NumberUnavailable is the number of nodes that should be running the daemon pod and have none of the daemon pod running and available (ready for at least minReadySeconds)
observedGeneration
integer
ObservedGeneration is the most recent generation observed by the daemon set controller.
updatedNumberScheduled
integer
UpdatedNumberScheduled is the total number of nodes that are running updated daemon pod

DaemonSetList v1beta1 extensions

Field 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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items
DaemonSet array
Items is a list of daemon sets.
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ListMeta
Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

RollingUpdateDaemonSet v1beta1 extensions

Field Description
maxUnavailable The maximum number of DaemonSet pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of total number of DaemonSet pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding up. This cannot be 0. Default value is 1. Example: when this is set to 30%, 30% of the currently running DaemonSet pods can be stopped for an update at any given time. The update starts by stopping at most 30% of the currently running DaemonSet pods and then brings up new DaemonSet pods in their place. Once the new pods are ready, it then proceeds onto other DaemonSet pods, thus ensuring that at least 70% of original number of DaemonSet pods are available at all times during the update.

Write Operations

See supported operations below...

Create

kubectl Command


$ echo 'apiVersion: extensions/v1beta1
kind: DaemonSet
metadata:
  name: daemonset-example
spec:
  template:
    metadata:
      labels:
        app: daemonset-example
    spec:
      containers:
      - name: daemonset-example
        image: ubuntu:trusty
        command:
        - /bin/sh
        args:
        - -c
        - >-
          while [ true ]; do
          echo "DaemonSet running on $(hostname)" ;
          sleep 10 ;
          done
' | kubectl create -f -

curl Command (requires kubectl proxy to be running)


$ kubectl proxy
$ curl -X POST -H 'Content-Type: application/yaml' --data '
apiVersion: extensions/v1beta1
kind: DaemonSet
metadata:
  name: daemonset-example
spec:
  template:
    metadata:
      labels:
        app: daemonset-example
    spec:
      containers:
      - name: daemonset-example
        image: ubuntu:trusty
        command:
        - /bin/sh
        args:
        - -c
        - >-
          while [ true ]; do
          echo "DaemonSet running on $(hostname)" ;
          sleep 10 ;
          done
' http://127.0.0.1:8001/apis/extensions/v1beta1/namespaces/default/daemonsets

Output


daemonset "daemonset-example" created

Response Body


{
  "kind": "DaemonSet",
  "apiVersion": "extensions/v1beta1",
  "metadata": {
    "name": "daemonset-example",
    "namespace": "default",
    "selfLink": "/apis/extensions/v1beta1/namespaces/default/daemonsets/daemonset-example",
    "uid": "65552ced-b0e2-11e6-aef0-42010af00229",
    "resourceVersion": "3558",
    "generation": 1,
    "creationTimestamp": "2016-11-22T18:35:09Z",
    "labels": {
      "app": "daemonset-example"
    }
  },
  "spec": {
    "selector": {
      "matchLabels": {
        "app": "daemonset-example"
      }
    },
    "template": {
      "metadata": {
        "creationTimestamp": null,
        "labels": {
          "app": "daemonset-example"
        }
      },
      "spec": {
        "containers": [
          {
            "name": "daemonset-example",
            "image": "ubuntu:trusty",
            "command": [
              "/bin/sh"
            ],
            "args": [
              "-c",
              "while [ true ]; do echo \"DaemonSet running on $(hostname)\" ; sleep 10 ; done"
            ],
            "resources": {},
            "terminationMessagePath": "/dev/termination-log",
            "imagePullPolicy": "IfNotPresent"
          }
        ],
        "restartPolicy": "Always",
        "terminationGracePeriodSeconds": 30,
        "dnsPolicy": "ClusterFirst",
        "securityContext": {}
      }
    }
  },
  "status": {
    "currentNumberScheduled": 0,
    "numberMisscheduled": 0,
    "desiredNumberScheduled": 0
  }
}

create a DaemonSet

HTTP Request

POST /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
DaemonSet

Response

Code Description
200
DaemonSet
OK

Replace

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

replace the specified DaemonSet

HTTP Request

PUT /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}

Path Parameters

Parameter Description
name name of the DaemonSet
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
DaemonSet

Response

Code Description
200
DaemonSet
OK

Patch

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

partially update the specified DaemonSet

HTTP Request

PATCH /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}

Path Parameters

Parameter Description
name name of the DaemonSet
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Patch

Response

Code Description
200
DaemonSet
OK

Delete

kubectl Command


$ kubectl delete daemonset daemonset-example

curl Command (requires kubectl proxy to be running)


$ kubectl proxy
$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
gracePeriodSeconds: 0
orphanDependents: false
' 'http://127.0.0.1:8001/apis/extensions/v1beta1/namespaces/default/daemonsets/daemonset-example'

Output


daemonset "daemonset-example" deleted

Response Body


{
  "kind": "Status",
  "apiVersion": "v1",
  "metadata": {},
  "status": "Success",
  "code": 200
}

delete a DaemonSet

HTTP Request

DELETE /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}

Path Parameters

Parameter Description
name name of the DaemonSet
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
gracePeriodSeconds 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 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 Whether and how garbage collection will be performed. Defaults to Default. Either this field or OrphanDependents may be set, but not both.

Body Parameters

Parameter Description
body
DeleteOptions

Response

Code Description
200
Status
OK

Delete Collection

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

delete collection of DaemonSet

HTTP Request

DELETE /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
Status
OK

Read Operations

See supported operations below...

Read

kubectl Command


$ kubectl get daemonset daemonset-example -o json

curl Command (requires kubectl proxy to be running)


$ kubectl proxy
$ curl -X GET http://127.0.0.1:8001/apis/extensions/v1beta1/namespaces/default/daemonsets/daemonset-example

Output


Response Body


read the specified DaemonSet

HTTP Request

GET /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}

Path Parameters

Parameter Description
name name of the DaemonSet
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
exact Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
export Should this value be exported. Export strips fields that a user can not specify.

Response

Code Description
200
DaemonSet
OK

List

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

list or watch objects of kind DaemonSet

HTTP Request

GET /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
DaemonSetList
OK

List All Namespaces

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

list or watch objects of kind DaemonSet

HTTP Request

GET /apis/extensions/v1beta1/daemonsets

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
DaemonSetList
OK

Watch

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch changes to an object of kind DaemonSet

HTTP Request

GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/daemonsets/{name}

Path Parameters

Parameter Description
name name of the DaemonSet
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Watch List

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch individual changes to a list of DaemonSet

HTTP Request

GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/daemonsets

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Watch List All Namespaces

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch individual changes to a list of DaemonSet

HTTP Request

GET /apis/extensions/v1beta1/watch/daemonsets

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Status Operations

See supported operations below...

Patch Status

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

partially update status of the specified DaemonSet

HTTP Request

PATCH /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}/status

Path Parameters

Parameter Description
name name of the DaemonSet
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Patch

Response

Code Description
200
DaemonSet
OK

Read Status

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

read status of the specified DaemonSet

HTTP Request

GET /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}/status

Path Parameters

Parameter Description
name name of the DaemonSet
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Response

Code Description
200
DaemonSet
OK

Replace Status

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

replace status of the specified DaemonSet

HTTP Request

PUT /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}/status

Path Parameters

Parameter Description
name name of the DaemonSet
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
DaemonSet

Response

Code Description
200
DaemonSet
OK

Deployment v1beta1 apps

Deployment Config to run 3 nginx instances (max rollback set to 10 revisions).


apiVersion: apps/v1beta1
kind: Deployment
metadata:
  # Unique key of the Deployment instance
  name: deployment-example
spec:
  # 3 Pods should exist at all times.
  replicas: 3
  template:
    metadata:
      labels:
        # Apply this label to pods and default
        # the Deployment label selector to this value
        app: nginx
    spec:
      containers:
      - name: nginx
        # Run this image
        image: nginx:1.10

Deployment Config to run 3 nginx instances (max rollback set to 10 revisions).


apiVersion: apps/v1beta1
kind: Deployment
metadata:
  # Unique key of the Deployment instance
  name: deployment-example
spec:
  # 3 Pods should exist at all times.
  replicas: 3
  template:
    metadata:
      labels:
        # Apply this label to pods and default
        # the Deployment label selector to this value
        app: nginx
    spec:
      containers:
      - name: nginx
        # Run this image
        image: nginx:1.10
Group Version Kind
apps v1beta1 Deployment

Deployment enables declarative updates for Pods and ReplicaSets.

Field 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: http://releases.k8s.io/HEAD/docs/devel/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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
Standard object metadata.
spec
DeploymentSpec
Specification of the desired behavior of the Deployment.
status
DeploymentStatus
Most recently observed status of the Deployment.

DeploymentSpec v1beta1 apps

Field Description
minReadySeconds
integer
Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
paused
boolean
Indicates that the deployment is paused.
progressDeadlineSeconds
integer
The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Once autoRollback is implemented, the deployment controller will automatically rollback failed deployments. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s.
replicas
integer
Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
revisionHistoryLimit
integer
The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 2.
rollbackTo
RollbackConfig
The config this deployment is rolling back to. Will be cleared after rollback is done.
selector
LabelSelector
Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment.
strategy
DeploymentStrategy
The deployment strategy to use to replace existing pods with new ones.
template
PodTemplateSpec
Template describes the pods that will be created.

DeploymentStatus v1beta1 apps

Field Description
availableReplicas
integer
Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.
conditions
DeploymentCondition array
Represents the latest available observations of a deployment's current state.
observedGeneration
integer
The generation observed by the deployment controller.
readyReplicas
integer
Total number of ready pods targeted by this deployment.
replicas
integer
Total number of non-terminated pods targeted by this deployment (their labels match the selector).
unavailableReplicas
integer
Total number of unavailable pods targeted by this deployment.
updatedReplicas
integer
Total number of non-terminated pods targeted by this deployment that have the desired template spec.

DeploymentList v1beta1 apps

Field 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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items
Deployment array
Items is the list of Deployments.
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ListMeta
Standard list metadata.

DeploymentStrategy v1beta1 apps

Field Description
rollingUpdate
RollingUpdateDeployment
Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate.
type
string
Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.

DeploymentRollback v1beta1 apps

Field 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: http://releases.k8s.io/HEAD/docs/devel/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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
name
string
Required: This must match the Name of a deployment.
rollbackTo
RollbackConfig
The config of this deployment rollback.
updatedAnnotations
object
The annotations to be updated to a deployment

RollingUpdateDeployment v1beta1 apps

Field Description
maxSurge The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new RC can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new RC can be scaled up further, ensuring that total number of pods running at any time during the update is atmost 130% of desired pods.
maxUnavailable The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old RC can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old RC can be scaled down further, followed by scaling up the new RC, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.

Write Operations

See supported operations below...

Create

kubectl Command


$ echo 'apiVersion: apps/v1beta1
kind: Deployment
metadata:
  name: deployment-example
spec:
  replicas: 3
  revisionHistoryLimit: 10
  template:
    metadata:
      labels:
        app: nginx
    spec:
      containers:
      - name: nginx
        image: nginx:1.10
        ports:
        - containerPort: 80
' | kubectl create -f -

curl Command (requires kubectl proxy to be running)


$ kubectl proxy
$ curl -X POST -H 'Content-Type: application/yaml' --data '
apiVersion: apps/v1beta1
kind: Deployment
metadata:
  name: deployment-example
spec:
  replicas: 3
  revisionHistoryLimit: 10
  template:
    metadata:
      labels:
        app: nginx
    spec:
      containers:
      - name: nginx
        image: nginx:1.10
        ports:
        - containerPort: 80
' http://127.0.0.1:8001/apis/apps/v1beta1/namespaces/default/deployments

Output


deployment "deployment-example" created

Response Body


{
  "kind": "Deployment",
  "apiVersion": "apps/v1beta1",
  "metadata": {
    "name": "deployment-example",
    "namespace": "default",
    "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
    "uid": "4ccca349-9cb1-11e6-9c54-42010a800148",
    "resourceVersion": "2118306",
    "generation": 1,
    "creationTimestamp": "2016-10-28T01:53:19Z",
    "labels": {
      "app": "nginx"
    }
  },
  "spec": {
    "replicas": 3,
    "selector": {
      "matchLabels": {
        "app": "nginx"
      }
    },
    "template": {
      "metadata": {
        "creationTimestamp": null,
        "labels": {
          "app": "nginx"
        }
      },
      "spec": {
        "containers": [
          {
            "name": "nginx",
            "image": "nginx:1.10",
            "ports": [
              {
                "containerPort": 80,
                "protocol": "TCP"
              }
            ],
            "resources": {},
            "terminationMessagePath": "/dev/termination-log",
            "imagePullPolicy": "IfNotPresent"
          }
        ],
        "restartPolicy": "Always",
        "terminationGracePeriodSeconds": 30,
        "dnsPolicy": "ClusterFirst",
        "securityContext": {}
      }
    },
    "strategy": {
      "type": "RollingUpdate",
      "rollingUpdate": {
        "maxUnavailable": 1,
        "maxSurge": 1
      }
    },
    "revisionHistoryLimit": 10
  },
  "status": {}
}

create a Deployment

HTTP Request

POST /apis/apps/v1beta1/namespaces/{namespace}/deployments

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Deployment

Response

Code Description
200
Deployment
OK

Replace

kubectl Command


$ echo 'apiVersion: apps/v1beta1
kind: Deployment
metadata:
  name: deployment-example
spec:
  replicas: 3
  revisionHistoryLimit: 10
  template:
    metadata:
      labels:
        app: nginx
    spec:
      containers:
      - name: nginx
        image: nginx:1.11
        ports:
        - containerPort: 80
' | kubectl replace -f -

curl Command (requires kubectl proxy to be running)


$ kubectl proxy
$ curl -X PUT -H 'Content-Type: application/yaml' --data '
apiVersion: apps/v1beta1
kind: Deployment
metadata:
  name: deployment-example
spec:
  replicas: 3
  revisionHistoryLimit: 10
  template:
    metadata:
      labels:
        app: nginx
    spec:
      containers:
      - name: nginx
        image: nginx:1.11
        ports:
        - containerPort: 80
' http://127.0.0.1:8001/apis/apps/v1beta1/namespaces/default/deployments/deployment-example

Output


deployment "deployment-example" replaced

Response Body


{
  "kind": "Deployment",
  "apiVersion": "apps/v1beta1",
  "metadata": {
    "name": "deployment-example",
    "namespace": "default",
    "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
    "uid": "4ccca349-9cb1-11e6-9c54-42010a800148",
    "resourceVersion": "2119082",
    "generation": 5,
    "creationTimestamp": "2016-10-28T01:53:19Z",
    "labels": {
      "app": "nginx"
    }
  },
  "spec": {
    "replicas": 3,
    "selector": {
      "matchLabels": {
        "app": "nginx"
      }
    },
    "template": {
      "metadata": {
        "creationTimestamp": null,
        "labels": {
          "app": "nginx"
        }
      },
      "spec": {
        "containers": [
          {
            "name": "nginx",
            "image": "nginx:1.11",
            "ports": [
              {
                "containerPort": 80,
                "protocol": "TCP"
              }
            ],
            "resources": {},
            "terminationMessagePath": "/dev/termination-log",
            "imagePullPolicy": "IfNotPresent"
          }
        ],
        "restartPolicy": "Always",
        "terminationGracePeriodSeconds": 30,
        "dnsPolicy": "ClusterFirst",
        "securityContext": {}
      }
    },
    "strategy": {
      "type": "RollingUpdate",
      "rollingUpdate": {
        "maxUnavailable": 1,
        "maxSurge": 1
      }
    },
    "revisionHistoryLimit": 10
  },
  "status": {
    "observedGeneration": 4,
    "replicas": 3,
    "updatedReplicas": 3,
    "availableReplicas": 3
  }
}

replace the specified Deployment

HTTP Request

PUT /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}

Path Parameters

Parameter Description
name name of the Deployment
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Deployment

Response

Code Description
200
Deployment
OK

Patch

kubectl Command


$ kubectl patch deployment deployment-example -p \
    '{"spec":{"template":{"spec":{"containers":[{"name":"nginx","image":"nginx:1.11"}]}}}}'

curl Command (requires kubectl proxy to be running)


$ kubectl proxy
$ curl -X PATCH -H 'Content-Type: application/strategic-merge-patch+json' --data '
{"spec":{"template":{"spec":{"containers":[{"name":"nginx","image":"nginx:1.11"}]}}}}' \
    'http://127.0.0.1:8001/apis/apps/v1beta1/namespaces/default/deployments/deployment-example'

Output


"deployment-example" patched

Response Body


{
  "kind": "Deployment",
  "apiVersion": "apps/v1beta1",
  "metadata": {
    "name": "deployment-example",
    "namespace": "default",
    "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
    "uid": "5dc3a8e6-b0ee-11e6-aef0-42010af00229",
    "resourceVersion": "164489",
    "generation": 11,
    "creationTimestamp": "2016-11-22T20:00:50Z",
    "labels": {
      "app": "nginx"
    },
    "annotations": {
      "deployment.kubernetes.io/revision": "5"
    }
  },
  "spec": {
    "replicas": 3,
    "selector": {
      "matchLabels": {
        "app": "nginx"
      }
    },
    "template": {
      "metadata": {
        "creationTimestamp": null,
        "labels": {
          "app": "nginx"
        }
      },
      "spec": {
        "containers": [
          {
            "name": "nginx",
            "image": "nginx:1.11",
            "ports": [
              {
                "containerPort": 80,
                "protocol": "TCP"
              }
            ],
            "resources": {},
            "terminationMessagePath": "/dev/termination-log",
            "imagePullPolicy": "IfNotPresent"
          }
        ],
        "restartPolicy": "Always",
        "terminationGracePeriodSeconds": 30,
        "dnsPolicy": "ClusterFirst",
        "securityContext": {}
      }
    },
    "strategy": {
      "type": "RollingUpdate",
      "rollingUpdate": {
        "maxUnavailable": 1,
        "maxSurge": 1
      }
    },
    "revisionHistoryLimit": 10
  },
  "status": {
    "observedGeneration": 10,
    "replicas": 3,
    "updatedReplicas": 3,
    "availableReplicas": 3
  }
}

partially update the specified Deployment

HTTP Request

PATCH /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}

Path Parameters

Parameter Description
name name of the Deployment
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Patch

Response

Code Description
200
Deployment
OK

Delete

kubectl Command


$ kubectl delete deployment deployment-example

curl Command (requires kubectl proxy to be running)


$ kubectl proxy
$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
gracePeriodSeconds: 0
orphanDependents: false
' 'http://127.0.0.1:8001/apis/apps/v1beta1/namespaces/default/deployments/deployment-example'

Output


deployment "deployment-example" deleted

Response Body


{
  "kind": "Status",
  "apiVersion": "v1",
  "metadata": {},
  "status": "Success",
  "code": 200
}

delete a Deployment

HTTP Request

DELETE /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}

Path Parameters

Parameter Description
name name of the Deployment
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
gracePeriodSeconds 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 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 Whether and how garbage collection will be performed. Defaults to Default. Either this field or OrphanDependents may be set, but not both.

Body Parameters

Parameter Description
body
DeleteOptions

Response

Code Description
200
Status
OK

Delete Collection

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

delete collection of Deployment

HTTP Request

DELETE /apis/apps/v1beta1/namespaces/{namespace}/deployments

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
Status
OK

Read Operations

See supported operations below...

Read

kubectl Command


$ kubectl get deployment deployment-example -o json

curl Command (requires kubectl proxy to be running)


$ kubectl proxy
$ curl -X GET http://127.0.0.1:8001/apis/apps/v1beta1/namespaces/default/deployments/deployment-example

Output


{
  "kind": "Deployment",
  "apiVersion": "apps/v1beta1",
  "metadata": {
    "name": "deployment-example",
    "namespace": "default",
    "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
    "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
    "resourceVersion": "2064726",
    "generation": 4,
    "creationTimestamp": "2016-10-27T16:33:35Z",
    "labels": {
      "app": "nginx"
    },
    "annotations": {
      "deployment.kubernetes.io/revision": "1"
    }
  },
  "spec": {
    "replicas": 3,
    "selector": {
      "matchLabels": {
        "app": "nginx"
      }
    },
    "template": {
      "metadata": {
        "creationTimestamp": null,
        "labels": {
          "app": "nginx"
        }
      },
      "spec": {
        "containers": [
          {
            "name": "nginx",
            "image": "nginx:1.10",
            "ports": [
              {
                "containerPort": 80,
                "protocol": "TCP"
              }
            ],
            "resources": {},
            "terminationMessagePath": "/dev/termination-log",
            "imagePullPolicy": "IfNotPresent"
          }
        ],
        "restartPolicy": "Always",
        "terminationGracePeriodSeconds": 30,
        "dnsPolicy": "ClusterFirst",
        "securityContext": {}
      }
    },
    "strategy": {
      "type": "RollingUpdate",
      "rollingUpdate": {
        "maxUnavailable": 1,
        "maxSurge": 1
      }
    }
  },
  "status": {
    "observedGeneration": 4,
    "replicas": 3,
    "updatedReplicas": 3,
    "availableReplicas": 3
  }
}

Response Body


{
  "kind": "Deployment",
  "apiVersion": "apps/v1beta1",
  "metadata": {
    "name": "deployment-example",
    "namespace": "default",
    "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
    "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
    "resourceVersion": "2064726",
    "generation": 4,
    "creationTimestamp": "2016-10-27T16:33:35Z",
    "labels": {
      "app": "nginx"
    },
    "annotations": {
      "deployment.kubernetes.io/revision": "1"
    }
  },
  "spec": {
    "replicas": 3,
    "selector": {
      "matchLabels": {
        "app": "nginx"
      }
    },
    "template": {
      "metadata": {
        "creationTimestamp": null,
        "labels": {
          "app": "nginx"
        }
      },
      "spec": {
        "containers": [
          {
            "name": "nginx",
            "image": "nginx:1.10",
            "ports": [
              {
                "containerPort": 80,
                "protocol": "TCP"
              }
            ],
            "resources": {},
            "terminationMessagePath": "/dev/termination-log",
            "imagePullPolicy": "IfNotPresent"
          }
        ],
        "restartPolicy": "Always",
        "terminationGracePeriodSeconds": 30,
        "dnsPolicy": "ClusterFirst",
        "securityContext": {}
      }
    },
    "strategy": {
      "type": "RollingUpdate",
      "rollingUpdate": {
        "maxUnavailable": 1,
        "maxSurge": 1
      }
    }
  },
  "status": {
    "observedGeneration": 4,
    "replicas": 3,
    "updatedReplicas": 3,
    "availableReplicas": 3
  }
}

read the specified Deployment

HTTP Request

GET /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}

Path Parameters

Parameter Description
name name of the Deployment
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
exact Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
export Should this value be exported. Export strips fields that a user can not specify.

Response

Code Description
200
Deployment
OK

List

kubectl Command


$ kubectl get deployment -o json

curl Command (requires kubectl proxy to be running)


$ kubectl proxy
$ curl -X GET 'http://127.0.0.1:8001/apis/apps/v1beta1/namespaces/default/deployments'

Output


{
  "kind": "List",
  "apiVersion": "v1",
  "metadata": {},
  "items": [
    {
      "kind": "Deployment",
      "apiVersion": "app/v1beta1",
      "metadata": {
        "name": "docs",
        "namespace": "default",
        "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/docs",
        "uid": "ef49e1d2-915e-11e6-be81-42010a80003f",
        "resourceVersion": "1924126",
        "generation": 21,
        "creationTimestamp": "2016-10-13T16:06:00Z",
        "labels": {
          "run": "docs"
        },
        "annotations": {
          "deployment.kubernetes.io/revision": "10",
          "replicatingperfection.net/push-image": "true"
        }
      },
      "spec": {
        "replicas": 1,
        "selector": {
          "matchLabels": {
            "run": "docs"
          }
        },
        "template": {
          "metadata": {
            "creationTimestamp": null,
            "labels": {
              "auto-pushed-image-pwittrock/api-docs": "1477496453",
              "run": "docs"
            }
          },
          "spec": {
            "containers": [
              {
                "name": "docs",
                "image": "pwittrock/api-docs:v9",
                "resources": {},
                "terminationMessagePath": "/dev/termination-log",
                "imagePullPolicy": "Always"
              }
            ],
            "restartPolicy": "Always",
            "terminationGracePeriodSeconds": 30,
            "dnsPolicy": "ClusterFirst",
            "securityContext": {}
          }
        },
        "strategy": {
          "type": "RollingUpdate",
          "rollingUpdate": {
            "maxUnavailable": 1,
            "maxSurge": 1
          }
        }
      },
      "status": {
        "observedGeneration": 21,
        "replicas": 1,
        "updatedReplicas": 1,
        "availableReplicas": 1
      }
    },
    {
      "kind": "Deployment",
      "apiVersion": "app/v1beta1",
      "metadata": {
        "name": "deployment-example",
        "namespace": "default",
        "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/deployment-example",
        "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
        "resourceVersion": "2064726",
        "generation": 4,
        "creationTimestamp": "2016-10-27T16:33:35Z",
        "labels": {
          "app": "nginx"
        },
        "annotations": {
          "deployment.kubernetes.io/revision": "1"
        }
      },
      "spec": {
        "replicas": 3,
        "selector": {
          "matchLabels": {
            "app": "nginx"
          }
        },
        "template": {
          "metadata": {
            "creationTimestamp": null,
            "labels": {
              "app": "nginx"
            }
          },
          "spec": {
            "containers": [
              {
                "name": "nginx",
                "image": "nginx:1.10",
                "ports": [
                  {
                    "containerPort": 80,
                    "protocol": "TCP"
                  }
                ],
                "resources": {},
                "terminationMessagePath": "/dev/termination-log",
                "imagePullPolicy": "IfNotPresent"
              }
            ],
            "restartPolicy": "Always",
            "terminationGracePeriodSeconds": 30,
            "dnsPolicy": "ClusterFirst",
            "securityContext": {}
          }
        },
        "strategy": {
          "type": "RollingUpdate",
          "rollingUpdate": {
            "maxUnavailable": 1,
            "maxSurge": 1
          }
        }
      },
      "status": {
        "observedGeneration": 4,
        "replicas": 3,
        "updatedReplicas": 3,
        "availableReplicas": 3
      }
    }
  ]
}

Response Body


{
  "kind": "List",
  "apiVersion": "v1",
  "metadata": {},
  "items": [
    {
      "kind": "Deployment",
      "apiVersion": "app/v1beta1",
      "metadata": {
        "name": "docs",
        "namespace": "default",
        "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/docs",
        "uid": "ef49e1d2-915e-11e6-be81-42010a80003f",
        "resourceVersion": "1924126",
        "generation": 21,
        "creationTimestamp": "2016-10-13T16:06:00Z",
        "labels": {
          "run": "docs"
        },
        "annotations": {
          "deployment.kubernetes.io/revision": "10",
          "replicatingperfection.net/push-image": "true"
        }
      },
      "spec": {
        "replicas": 1,
        "selector": {
          "matchLabels": {
            "run": "docs"
          }
        },
        "template": {
          "metadata": {
            "creationTimestamp": null,
            "labels": {
              "auto-pushed-image-pwittrock/api-docs": "1477496453",
              "run": "docs"
            }
          },
          "spec": {
            "containers": [
              {
                "name": "docs",
                "image": "pwittrock/api-docs:v9",
                "resources": {},
                "terminationMessagePath": "/dev/termination-log",
                "imagePullPolicy": "Always"
              }
            ],
            "restartPolicy": "Always",
            "terminationGracePeriodSeconds": 30,
            "dnsPolicy": "ClusterFirst",
            "securityContext": {}
          }
        },
        "strategy": {
          "type": "RollingUpdate",
          "rollingUpdate": {
            "maxUnavailable": 1,
            "maxSurge": 1
          }
        }
      },
      "status": {
        "observedGeneration": 21,
        "replicas": 1,
        "updatedReplicas": 1,
        "availableReplicas": 1
      }
    },
    {
      "kind": "Deployment",
      "apiVersion": "app/v1beta1",
      "metadata": {
        "name": "deployment-example",
        "namespace": "default",
        "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/deployment-example",
        "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
        "resourceVersion": "2064726",
        "generation": 4,
        "creationTimestamp": "2016-10-27T16:33:35Z",
        "labels": {
          "app": "nginx"
        },
        "annotations": {
          "deployment.kubernetes.io/revision": "1"
        }
      },
      "spec": {
        "replicas": 3,
        "selector": {
          "matchLabels": {
            "app": "nginx"
          }
        },
        "template": {
          "metadata": {
            "creationTimestamp": null,
            "labels": {
              "app": "nginx"
            }
          },
          "spec": {
            "containers": [
              {
                "name": "nginx",
                "image": "nginx:1.10",
                "ports": [
                  {
                    "containerPort": 80,
                    "protocol": "TCP"
                  }
                ],
                "resources": {},
                "terminationMessagePath": "/dev/termination-log",
                "imagePullPolicy": "IfNotPresent"
              }
            ],
            "restartPolicy": "Always",
            "terminationGracePeriodSeconds": 30,
            "dnsPolicy": "ClusterFirst",
            "securityContext": {}
          }
        },
        "strategy": {
          "type": "RollingUpdate",
          "rollingUpdate": {
            "maxUnavailable": 1,
            "maxSurge": 1
          }
        }
      },
      "status": {
        "observedGeneration": 4,
        "replicas": 3,
        "updatedReplicas": 3,
        "availableReplicas": 3
      }
    }
  ]
}

list or watch objects of kind Deployment

HTTP Request

GET /apis/apps/v1beta1/namespaces/{namespace}/deployments

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
DeploymentList
OK

List All Namespaces

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

list or watch objects of kind Deployment

HTTP Request

GET /apis/apps/v1beta1/deployments

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
DeploymentList
OK

Watch

kubectl Command


$ kubectl get deployment deployment-example --watch -o json

curl Command (requires kubectl proxy to be running)


$ kubectl proxy
$ curl -X GET 'http://127.0.0.1:8001/apis/apps/v1beta1/watch/namespaces/default/deployments/deployment-example'

Output


{
    "type": "ADDED",
    "object": {
        "kind": "Deployment",
        "apiVersion": "apps/v1beta1",
        "metadata": {
            "name": "deployment-example",
            "namespace": "default",
            "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
            "uid": "64c12290-9cbf-11e6-9c54-42010a800148",
            "resourceVersion": "2128095",
            "generation": 2,
            "creationTimestamp": "2016-10-28T03:34:12Z",
            "labels": {
                "app": "nginx"
            },
            "annotations": {
                "deployment.kubernetes.io/revision": "3"
            }
        },
        "spec": {
            "replicas": 3,
            "selector": {
                "matchLabels": {
                    "app": "nginx"
                }
            },
            "template": {
                "metadata": {
                    "creationTimestamp": null,
                    "labels": {
                        "app": "nginx"
                    }
                },
                "spec": {
                    "containers": [
                        {
                            "name": "nginx",
                            "image": "nginx:1.10",
                            "ports": [
                                {
                                    "containerPort": 80,
                                    "protocol": "TCP"
                                }
                            ],
                            "resources": {
                            },
                            "terminationMessagePath": "/dev/termination-log",
                            "imagePullPolicy": "IfNotPresent"
                        }
                    ],
                    "restartPolicy": "Always",
                    "terminationGracePeriodSeconds": 30,
                    "dnsPolicy": "ClusterFirst",
                    "securityContext": {
                    }
                }
            },
            "strategy": {
                "type": "RollingUpdate",
                "rollingUpdate": {
                    "maxUnavailable": 1,
                    "maxSurge": 1
                }
            }
        },
        "status": {
            "observedGeneration": 2,
            "replicas": 3,
            "updatedReplicas": 3,
            "availableReplicas": 3
        }
    }
}

Response Body


{
    "type": "ADDED",
    "object": {
        "kind": "Deployment",
        "apiVersion": "apps/v1beta1",
        "metadata": {
            "name": "deployment-example",
            "namespace": "default",
            "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
            "uid": "64c12290-9cbf-11e6-9c54-42010a800148",
            "resourceVersion": "2128095",
            "generation": 2,
            "creationTimestamp": "2016-10-28T03:34:12Z",
            "labels": {
                "app": "nginx"
            },
            "annotations": {
                "deployment.kubernetes.io/revision": "3"
            }
        },
        "spec": {
            "replicas": 3,
            "selector": {
                "matchLabels": {
                    "app": "nginx"
                }
            },
            "template": {
                "metadata": {
                    "creationTimestamp": null,
                    "labels": {
                        "app": "nginx"
                    }
                },
                "spec": {
                    "containers": [
                        {
                            "name": "nginx",
                            "image": "nginx:1.10",
                            "ports": [
                                {
                                    "containerPort": 80,
                                    "protocol": "TCP"
                                }
                            ],
                            "resources": {
                            },
                            "terminationMessagePath": "/dev/termination-log",
                            "imagePullPolicy": "IfNotPresent"
                        }
                    ],
                    "restartPolicy": "Always",
                    "terminationGracePeriodSeconds": 30,
                    "dnsPolicy": "ClusterFirst",
                    "securityContext": {
                    }
                }
            },
            "strategy": {
                "type": "RollingUpdate",
                "rollingUpdate": {
                    "maxUnavailable": 1,
                    "maxSurge": 1
                }
            }
        },
        "status": {
            "observedGeneration": 2,
            "replicas": 3,
            "updatedReplicas": 3,
            "availableReplicas": 3
        }
    }
}

watch changes to an object of kind Deployment

HTTP Request

GET /apis/apps/v1beta1/watch/namespaces/{namespace}/deployments/{name}

Path Parameters

Parameter Description
name name of the Deployment
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Watch List

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch individual changes to a list of Deployment

HTTP Request

GET /apis/apps/v1beta1/watch/namespaces/{namespace}/deployments

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Watch List All Namespaces

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch individual changes to a list of Deployment

HTTP Request

GET /apis/apps/v1beta1/watch/deployments

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Status Operations

See supported operations below...

Patch Status

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

partially update status of the specified Deployment

HTTP Request

PATCH /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/status

Path Parameters

Parameter Description
name name of the Deployment
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Patch

Response

Code Description
200
Deployment
OK

Read Status

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

read status of the specified Deployment

HTTP Request

GET /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/status

Path Parameters

Parameter Description
name name of the Deployment
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Response

Code Description
200
Deployment
OK

Replace Status

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

replace status of the specified Deployment

HTTP Request

PUT /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/status

Path Parameters

Parameter Description
name name of the Deployment
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Deployment

Response

Code Description
200
Deployment
OK

Misc Operations

See supported operations below...

Rollback

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

create rollback of a DeploymentRollback

HTTP Request

POST /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/rollback

Path Parameters

Parameter Description
name name of the DeploymentRollback
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
DeploymentRollback

Response

Code Description
200
DeploymentRollback
OK

Job v1 batch

Job Config to print pi up to 2000 digits (then exit).


apiVersion: batch/v1
kind: Job
metadata:
  # Unique key of the Job instance
  name: example-job
spec:
  template:
    metadata:
      name: example-job
    spec:
      containers:
      - name: pi
        image: perl
        command: ["perl"]
        args: ["-Mbignum=bpi", "-wle", "print bpi(2000)"]
      # Do not restart containers after they exit
      restartPolicy: Never

Job Config to print pi up to 2000 digits (then exit).


apiVersion: batch/v1
kind: Job
metadata:
  # Unique key of the Job instance
  name: example-job
spec:
  template:
    metadata:
      name: example-job
    spec:
      containers:
      - name: pi
        image: perl
        command: ["perl"]
        args: ["-Mbignum=bpi", "-wle", "print bpi(2000)"]
      # Do not restart containers after they exit
      restartPolicy: Never
Group Version Kind
batch v1 Job

Job represents the configuration of a single job.

Field 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: http://releases.k8s.io/HEAD/docs/devel/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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec
JobSpec
Spec is a structure defining the expected behavior of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
status
JobStatus
Status is a structure describing current status of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

JobSpec v1 batch

Field Description
activeDeadlineSeconds
integer
Optional duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer
completions
integer
Completions specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: http://kubernetes.io/docs/user-guide/jobs
manualSelector
boolean
ManualSelector controls generation of pod labels and pod selectors. Leave manualSelector unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see manualSelector=true in jobs that were created with the old extensions/v1beta1 API. More info: http://releases.k8s.io/HEAD/docs/design/selector-generation.md
parallelism
integer
Parallelism specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: http://kubernetes.io/docs/user-guide/jobs
selector
LabelSelector
Selector is a label query over pods that should match the pod count. Normally, the system sets this field for you. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
template
PodTemplateSpec
Template is the object that describes the pod that will be created when executing a job. More info: http://kubernetes.io/docs/user-guide/jobs

JobStatus v1 batch

Field Description
active
integer
Active is the number of actively running pods.
completionTime
Time
CompletionTime represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.
conditions
JobCondition array
Conditions represent the latest available observations of an object's current state. More info: http://kubernetes.io/docs/user-guide/jobs
failed
integer
Failed is the number of pods which reached Phase Failed.
startTime
Time
StartTime represents time when the job was acknowledged by the Job Manager. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.
succeeded
integer
Succeeded is the number of pods which reached Phase Succeeded.

JobList v1 batch

Field 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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items
Job array
Items is the list of Job.
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ListMeta
Standard list metadata More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

Write Operations

See supported operations below...

Create

kubectl Command


$ echo 'apiVersion: batch/v1
kind: Job
metadata:
  name: example-job
spec:
  template:
    metadata:
      name: example-job
    spec:
      containers:
      - name: pi
        image: perl
        command: ["perl",  "-Mbignum=bpi", "-wle", "print bpi(2000)"]
      restartPolicy: Never
' | kubectl create -f -

curl Command (requires kubectl proxy to be running)


$ kubectl proxy
$ curl -X POST -H 'Content-Type: application/yaml' --data '
apiVersion: batch/v1
kind: Job
metadata:
  name: example-job
spec:
  template:
    metadata:
      name: example-job
    spec:
      containers:
      - name: pi
        image: perl
        command: ["perl",  "-Mbignum=bpi", "-wle", "print bpi(2000)"]
      restartPolicy: Never
' http://127.0.0.1:8001/apis/batch/v1/namespaces/default/jobs

Output


job "example-job" created

Response Body


{
  "kind": "Job",
  "apiVersion": "batch/v1",
  "metadata": {
    "name": "example-job",
    "namespace": "default",
    "selfLink": "/apis/batch/v1/namespaces/default/jobs/example-job",
    "uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
    "resourceVersion": "7479",
    "creationTimestamp": "2016-11-04T18:45:25Z"
  },
  "spec": {
    "parallelism": 1,
    "completions": 1,
    "selector": {
      "matchLabels": {
        "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
      }
    },
    "template": {
      "metadata": {
        "name": "example-job",
        "creationTimestamp": null,
        "labels": {
          "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
          "job-name": "example-job"
        }
      },
      "spec": {
        "containers": [
          {
            "name": "pi",
            "image": "perl",
            "command": [
              "perl",
              "-Mbignum=bpi",
              "-wle",
              "print bpi(2000)"
            ],
            "resources": {},
            "terminationMessagePath": "/dev/termination-log",
            "imagePullPolicy": "Always"
          }
        ],
        "restartPolicy": "Never",
        "terminationGracePeriodSeconds": 30,
        "dnsPolicy": "ClusterFirst",
        "securityContext": {}
      }
    }
  },
  "status": {}
}

create a Job

HTTP Request

POST /apis/batch/v1/namespaces/{namespace}/jobs

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Job

Response

Code Description
200
Job
OK

Replace

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

replace the specified Job

HTTP Request

PUT /apis/batch/v1/namespaces/{namespace}/jobs/{name}

Path Parameters

Parameter Description
name name of the Job
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Job

Response

Code Description
200
Job
OK

Patch

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

partially update the specified Job

HTTP Request

PATCH /apis/batch/v1/namespaces/{namespace}/jobs/{name}

Path Parameters

Parameter Description
name name of the Job
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Patch

Response

Code Description
200
Job
OK

Delete

kubectl Command


$ kubectl delete job example-job

curl Command (requires kubectl proxy to be running)


$ kubectl proxy
$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
gracePeriodSeconds: 0
orphanDependents: false
' 'http://127.0.0.1:8001/apis/batch/v1/namespaces/default/jobs/example-job'

Output


job "example-job" deleted

Response Body


{
  "kind": "Status",
  "apiVersion": "v1",
  "metadata": {},
  "status": "Success",
  "code": 200
}

delete a Job

HTTP Request

DELETE /apis/batch/v1/namespaces/{namespace}/jobs/{name}

Path Parameters

Parameter Description
name name of the Job
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
gracePeriodSeconds 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 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 Whether and how garbage collection will be performed. Defaults to Default. Either this field or OrphanDependents may be set, but not both.

Body Parameters

Parameter Description
body
DeleteOptions

Response

Code Description
200
Status
OK

Delete Collection

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

delete collection of Job

HTTP Request

DELETE /apis/batch/v1/namespaces/{namespace}/jobs

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
Status
OK

Read Operations

See supported operations below...

Read

kubectl Command


$ kubectl get job example-job -o json

curl Command (requires kubectl proxy to be running)


$ kubectl proxy
$ curl -X GET http://127.0.0.1:8001/apis/batch/v1/namespaces/default/jobs/example-job

Output


{
  "kind": "Job",
  "apiVersion": "batch/v1",
  "metadata": {
    "name": "example-job",
    "namespace": "default",
    "selfLink": "/apis/batch/v1/namespaces/default/jobs/example-job",
    "uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
    "resourceVersion": "7482",
    "creationTimestamp": "2016-11-04T18:45:25Z"
  },
  "spec": {
    "parallelism": 1,
    "completions": 1,
    "selector": {
      "matchLabels": {
        "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
      }
    },
    "template": {
      "metadata": {
        "name": "example-job",
        "creationTimestamp": null,
        "labels": {
          "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
          "job-name": "example-job"
        }
      },
      "spec": {
        "containers": [
          {
            "name": "pi",
            "image": "perl",
            "command": [
              "perl",
              "-Mbignum=bpi",
              "-wle",
              "print bpi(2000)"
            ],
            "resources": {},
            "terminationMessagePath": "/dev/termination-log",
            "imagePullPolicy": "Always"
          }
        ],
        "restartPolicy": "Never",
        "terminationGracePeriodSeconds": 30,
        "dnsPolicy": "ClusterFirst",
        "securityContext": {}
      }
    }
  },
  "status": {
    "startTime": "2016-11-04T18:45:25Z",
    "active": 1
  }
}

Response Body


{
  "kind": "Job",
  "apiVersion": "batch/v1",
  "metadata": {
    "name": "example-job",
    "namespace": "default",
    "selfLink": "/apis/batch/v1/namespaces/default/jobs/example-job",
    "uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
    "resourceVersion": "7482",
    "creationTimestamp": "2016-11-04T18:45:25Z"
  },
  "spec": {
    "parallelism": 1,
    "completions": 1,
    "selector": {
      "matchLabels": {
        "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
      }
    },
    "template": {
      "metadata": {
        "name": "example-job",
        "creationTimestamp": null,
        "labels": {
          "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
          "job-name": "example-job"
        }
      },
      "spec": {
        "containers": [
          {
            "name": "pi",
            "image": "perl",
            "command": [
              "perl",
              "-Mbignum=bpi",
              "-wle",
              "print bpi(2000)"
            ],
            "resources": {},
            "terminationMessagePath": "/dev/termination-log",
            "imagePullPolicy": "Always"
          }
        ],
        "restartPolicy": "Never",
        "terminationGracePeriodSeconds": 30,
        "dnsPolicy": "ClusterFirst",
        "securityContext": {}
      }
    }
  },
  "status": {
    "startTime": "2016-11-04T18:45:25Z",
    "active": 1
  }
}

read the specified Job

HTTP Request

GET /apis/batch/v1/namespaces/{namespace}/jobs/{name}

Path Parameters

Parameter Description
name name of the Job
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
exact Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
export Should this value be exported. Export strips fields that a user can not specify.

Response

Code Description
200
Job
OK

List

kubectl Command


$ kubectl get job -o json

curl Command (requires kubectl proxy to be running)


$ kubectl proxy
$ curl -X GET 'http://127.0.0.1:8001/apis/batch/v1/namespaces/default/jobs'

Output


{
  "kind": "JobList",
  "apiVersion": "batch/v1",
  "metadata": {
    "selfLink": "/apis/batch/v1/namespaces/default/jobs",
    "resourceVersion": "7589"
  },
  "items": [
    {
      "metadata": {
        "name": "",
        "namespace": "default",
        "selfLink": "/apis/batch/v1/namespaces/default/jobs/",
        "uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
        "resourceVersion": "7482",
        "creationTimestamp": "2016-11-04T18:45:25Z"
      },
      "spec": {
        "parallelism": 1,
        "completions": 1,
        "selector": {
          "matchLabels": {
            "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
          }
        },
        "template": {
          "metadata": {
            "name": "",
            "creationTimestamp": null,
            "labels": {
              "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
              "job-name": ""
            }
          },
          "spec": {
            "containers": [
              {
                "name": "pi",
                "image": "perl",
                "command": [
                  "perl",
                  "-Mbignum=bpi",
                  "-wle",
                  "print bpi(2000)"
                ],
                "resources": {},
                "terminationMessagePath": "/dev/termination-log",
                "imagePullPolicy": "Always"
              }
            ],
            "restartPolicy": "Never",
            "terminationGracePeriodSeconds": 30,
            "dnsPolicy": "ClusterFirst",
            "securityContext": {}
          }
        }
      },
      "status": {
        "startTime": "2016-11-04T18:45:25Z",
        "active": 1
      }
    }
  ]
}

Response Body


{
  "kind": "JobList",
  "apiVersion": "batch/v1",
  "metadata": {
    "selfLink": "/apis/batch/v1/namespaces/default/jobs",
    "resourceVersion": "7589"
  },
  "items": [
    {
      "metadata": {
        "name": "",
        "namespace": "default",
        "selfLink": "/apis/batch/v1/namespaces/default/jobs/",
        "uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
        "resourceVersion": "7482",
        "creationTimestamp": "2016-11-04T18:45:25Z"
      },
      "spec": {
        "parallelism": 1,
        "completions": 1,
        "selector": {
          "matchLabels": {
            "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
          }
        },
        "template": {
          "metadata": {
            "name": "",
            "creationTimestamp": null,
            "labels": {
              "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
              "job-name": ""
            }
          },
          "spec": {
            "containers": [
              {
                "name": "pi",
                "image": "perl",
                "command": [
                  "perl",
                  "-Mbignum=bpi",
                  "-wle",
                  "print bpi(2000)"
                ],
                "resources": {},
                "terminationMessagePath": "/dev/termination-log",
                "imagePullPolicy": "Always"
              }
            ],
            "restartPolicy": "Never",
            "terminationGracePeriodSeconds": 30,
            "dnsPolicy": "ClusterFirst",
            "securityContext": {}
          }
        }
      },
      "status": {
        "startTime": "2016-11-04T18:45:25Z",
        "active": 1
      }
    }
  ]
}

list or watch objects of kind Job

HTTP Request

GET /apis/batch/v1/namespaces/{namespace}/jobs

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
JobList
OK

List All Namespaces

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

list or watch objects of kind Job

HTTP Request

GET /apis/batch/v1/jobs

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
JobList
OK

Watch

kubectl Command


$ kubectl get job example-job --watch -o json

curl Command (requires kubectl proxy to be running)


$ kubectl proxy
$ curl -X GET 'http://127.0.0.1:8001/apis/batch/v1/watch/namespaces/default/jobs/example-job'

Output


{
    "type": "ADDED",
    "object": {
        "kind": "Job",
        "apiVersion": "batch/v1",
        "metadata": {
            "name": "example-job",
            "namespace": "default",
            "selfLink": "/apis/batch/v1/namespaces/default/jobs/example-job",
            "uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
            "resourceVersion": "7482",
            "creationTimestamp": "2016-11-04T18:45:25Z"
        },
        "spec": {
            "parallelism": 1,
            "completions": 1,
            "selector": {
                "matchLabels": {
                    "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
                }
            },
            "template": {
                "metadata": {
                    "name": "example-job",
                    "creationTimestamp": null,
                    "labels": {
                        "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
                        "job-name": "example-job"
                    }
                },
                "spec": {
                    "containers": [
                        {
                            "name": "pi",
                            "image": "perl",
                            "command": [
                                "perl",
                                "-Mbignum=bpi",
                                "-wle",
                                "print bpi(2000)"
                            ],
                            "resources": {
                            },
                            "terminationMessagePath": "/dev/termination-log",
                            "imagePullPolicy": "Always"
                        }
                    ],
                    "restartPolicy": "Never",
                    "terminationGracePeriodSeconds": 30,
                    "dnsPolicy": "ClusterFirst",
                    "securityContext": {
                    }
                }
            }
        },
        "status": {
            "startTime": "2016-11-04T18:45:25Z",
            "active": 1
        }
    }
}

Response Body


{
    "type": "ADDED",
    "object": {
        "kind": "Job",
        "apiVersion": "batch/v1",
        "metadata": {
            "name": "example-job",
            "namespace": "default",
            "selfLink": "/apis/batch/v1/namespaces/default/jobs/example-job",
            "uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
            "resourceVersion": "7482",
            "creationTimestamp": "2016-11-04T18:45:25Z"
        },
        "spec": {
            "parallelism": 1,
            "completions": 1,
            "selector": {
                "matchLabels": {
                    "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
                }
            },
            "template": {
                "metadata": {
                    "name": "example-job",
                    "creationTimestamp": null,
                    "labels": {
                        "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
                        "job-name": "example-job"
                    }
                },
                "spec": {
                    "containers": [
                        {
                            "name": "pi",
                            "image": "perl",
                            "command": [
                                "perl",
                                "-Mbignum=bpi",
                                "-wle",
                                "print bpi(2000)"
                            ],
                            "resources": {
                            },
                            "terminationMessagePath": "/dev/termination-log",
                            "imagePullPolicy": "Always"
                        }
                    ],
                    "restartPolicy": "Never",
                    "terminationGracePeriodSeconds": 30,
                    "dnsPolicy": "ClusterFirst",
                    "securityContext": {
                    }
                }
            }
        },
        "status": {
            "startTime": "2016-11-04T18:45:25Z",
            "active": 1
        }
    }
}

watch changes to an object of kind Job

HTTP Request

GET /apis/batch/v1/watch/namespaces/{namespace}/jobs/{name}

Path Parameters

Parameter Description
name name of the Job
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Watch List

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch individual changes to a list of Job

HTTP Request

GET /apis/batch/v1/watch/namespaces/{namespace}/jobs

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Watch List All Namespaces

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch individual changes to a list of Job

HTTP Request

GET /apis/batch/v1/watch/jobs

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Status Operations

See supported operations below...

Patch Status

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

partially update status of the specified Job

HTTP Request

PATCH /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status

Path Parameters

Parameter Description
name name of the Job
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Patch

Response

Code Description
200
Job
OK

Read Status

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

read status of the specified Job

HTTP Request

GET /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status

Path Parameters

Parameter Description
name name of the Job
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Response

Code Description
200
Job
OK

Replace Status

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

replace status of the specified Job

HTTP Request

PUT /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status

Path Parameters

Parameter Description
name name of the Job
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Job

Response

Code Description
200
Job
OK

Pod v1 core

Pod Config to print "Hello World".


apiVersion: v1
kind: Pod
metadata:
  name: pod-example
spec:
  containers:
  - image: ubuntu:trusty
    command: ["echo"]
    args: ["Hello World"]

Pod Config to print "Hello World".


apiVersion: v1
kind: Pod
metadata:
  name: pod-example
spec:
  containers:
  - image: ubuntu:trusty
    command: ["echo"]
    args: ["Hello World"]
Group Version Kind
Core v1 Pod

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

Field 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: http://releases.k8s.io/HEAD/docs/devel/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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec
PodSpec
Specification of the desired behavior of the pod. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
status
PodStatus
Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

PodSpec v1 core

Field 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
If specified, the pod's scheduling constraints
automountServiceAccountToken
boolean
AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.
containers
Container array
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. More info: http://kubernetes.io/docs/user-guide/containers
dnsPolicy
string
Set DNS policy for containers within the pod. One of 'ClusterFirstWithHostNet', 'ClusterFirst' or 'Default'. Defaults to "ClusterFirst". To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.
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
LocalObjectReference array
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: http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod
initContainers
Container array
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, or Liveness 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: http://kubernetes.io/docs/user-guide/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
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/#nodeselector
restartPolicy
string
Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: http://kubernetes.io/docs/user-guide/pod-states#restartpolicy
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
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: http://releases.k8s.io/HEAD/docs/design/service_accounts.md
subdomain
string
If specified, the fully qualified Pod hostname will be "...svc.". 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
Toleration array
If specified, the pod's tolerations.
volumes
Volume array
List of volumes that can be mounted by containers belonging to the pod. More info: http://kubernetes.io/docs/user-guide/volumes

PodStatus v1 core

Field Description
conditions
PodCondition array
Current service state of pod. More info: http://kubernetes.io/docs/user-guide/pod-states#pod-conditions
containerStatuses
ContainerStatus array
The list has one entry per container in the manifest. Each entry is currently the output of docker inspect. More info: http://kubernetes.io/docs/user-guide/pod-states#container-statuses
hostIP
string
IP address of the host to which the pod is assigned. Empty if not yet scheduled.
initContainerStatuses
ContainerStatus 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: http://kubernetes.io/docs/user-guide/pod-states#container-statuses
message
string
A human readable message indicating details about why the pod is in this condition.
phase
string
Current condition of the pod. More info: http://kubernetes.io/docs/user-guide/pod-states#pod-phase
podIP
string
IP address allocated to the pod. Routable at least within the cluster. Empty if not yet allocated.
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/resource-qos.md
reason
string
A brief CamelCase message indicating details about why the pod is in this state. e.g. 'OutOfDisk'
startTime
Time
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.

PodList v1 core

Field 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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items
Pod array
List of pods. More info: http://kubernetes.io/docs/user-guide/pods
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ListMeta
Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

Write Operations

See supported operations below...

Create

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

create a Pod

HTTP Request

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

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Pod

Response

Code Description
200
Pod
OK

Replace

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

replace the specified Pod

HTTP Request

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

Path Parameters

Parameter Description
name name of the Pod
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Pod

Response

Code Description
200
Pod
OK

Patch

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

partially update the specified Pod

HTTP Request

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

Path Parameters

Parameter Description
name name of the Pod
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Patch

Response

Code Description
200
Pod
OK

Delete

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

delete a Pod

HTTP Request

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

Path Parameters

Parameter Description
name name of the Pod
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
gracePeriodSeconds 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 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 Whether and how garbage collection will be performed. Defaults to Default. Either this field or OrphanDependents may be set, but not both.

Body Parameters

Parameter Description
body
DeleteOptions

Response

Code Description
200
Status
OK

Delete Collection

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

delete collection of Pod

HTTP Request

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

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
Status
OK

Read Operations

See supported operations below...

Read

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

read the specified Pod

HTTP Request

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

Path Parameters

Parameter Description
name name of the Pod
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
exact Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
export Should this value be exported. Export strips fields that a user can not specify.

Response

Code Description
200
Pod
OK

List

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

list or watch objects of kind Pod

HTTP Request

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

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
PodList
OK

List All Namespaces

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

list or watch objects of kind Pod

HTTP Request

GET /api/v1/pods

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
PodList
OK

Watch

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch changes to an object of kind Pod

HTTP Request

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

Path Parameters

Parameter Description
name name of the Pod
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Watch List

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch individual changes to a list of Pod

HTTP Request

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

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Watch List All Namespaces

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch individual changes to a list of Pod

HTTP Request

GET /api/v1/watch/pods

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Status Operations

See supported operations below...

Patch Status

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

partially update status of the specified Pod

HTTP Request

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

Path Parameters

Parameter Description
name name of the Pod
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Patch

Response

Code Description
200
Pod
OK

Read Status

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

read status of the specified Pod

HTTP Request

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

Path Parameters

Parameter Description
name name of the Pod
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Response

Code Description
200
Pod
OK

Replace Status

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

replace status of the specified Pod

HTTP Request

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

Path Parameters

Parameter Description
name name of the Pod
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Pod

Response

Code Description
200
Pod
OK

Proxy Operations

See supported operations below...

Create Connect Portforward

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

connect POST requests to portforward of Pod

HTTP Request

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

Path Parameters

Parameter Description
name name of the Pod
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
ports List of ports to forward Required when using WebSockets

Response

Code Description
200
string
OK

Create Connect Proxy

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

connect POST requests to proxy of Pod

HTTP Request

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

Path Parameters

Parameter Description
name name of the Pod
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
path Path is the URL path to use for the current proxy request to pod.

Response

Code Description
200
string
OK

Create Connect Proxy Path

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

connect POST requests to proxy of Pod

HTTP Request

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

Path Parameters

Parameter Description
name name of the Pod
namespace object name and auth scope, such as for teams and projects
path path to the resource

Query Parameters

Parameter Description
path Path is the URL path to use for the current proxy request to pod.

Response

Code Description
200
string
OK

Create Proxy

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

proxy POST requests to Pod

HTTP Request

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

Path Parameters

Parameter Description
name name of the Pod
namespace object name and auth scope, such as for teams and projects

Response

Code Description
200
string
OK

Create Proxy Path

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

proxy POST requests to Pod

HTTP Request

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

Path Parameters

Parameter Description
name name of the Pod
namespace object name and auth scope, such as for teams and projects
path path to the resource

Response

Code Description
200
string
OK

Delete Connect Proxy

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

connect DELETE requests to proxy of Pod

HTTP Request

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

Path Parameters

Parameter Description
name name of the Pod
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
path Path is the URL path to use for the current proxy request to pod.

Response

Code Description
200
string
OK

Delete Connect Proxy Path

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

connect DELETE requests to proxy of Pod

HTTP Request

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

Path Parameters

Parameter Description
name name of the Pod
namespace object name and auth scope, such as for teams and projects
path path to the resource

Query Parameters

Parameter Description
path Path is the URL path to use for the current proxy request to pod.

Response

Code Description
200
string
OK

Delete Proxy

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

proxy DELETE requests to Pod

HTTP Request

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

Path Parameters

Parameter Description
name name of the Pod
namespace object name and auth scope, such as for teams and projects

Response

Code Description
200
string
OK

Delete Proxy Path

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

proxy DELETE requests to Pod

HTTP Request

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

Path Parameters

Parameter Description
name name of the Pod
namespace object name and auth scope, such as for teams and projects
path path to the resource

Response

Code Description
200
string
OK

Get Connect Portforward

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

connect GET requests to portforward of Pod

HTTP Request

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

Path Parameters

Parameter Description
name name of the Pod
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
ports List of ports to forward Required when using WebSockets

Response

Code Description
200
string
OK

Get Connect Proxy

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

connect GET requests to proxy of Pod

HTTP Request

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

Path Parameters

Parameter Description
name name of the Pod
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
path Path is the URL path to use for the current proxy request to pod.

Response

Code Description
200
string
OK

Get Connect Proxy Path

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

connect GET requests to proxy of Pod

HTTP Request

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

Path Parameters

Parameter Description
name name of the Pod
namespace object name and auth scope, such as for teams and projects
path path to the resource

Query Parameters

Parameter Description
path Path is the URL path to use for the current proxy request to pod.

Response

Code Description
200
string
OK

Get Proxy

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

proxy GET requests to Pod

HTTP Request

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

Path Parameters

Parameter Description
name name of the Pod
namespace object name and auth scope, such as for teams and projects

Response

Code Description
200
string
OK

Get Proxy Path

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

proxy GET requests to Pod

HTTP Request

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

Path Parameters

Parameter Description
name name of the Pod
namespace object name and auth scope, such as for teams and projects
path path to the resource

Response

Code Description
200
string
OK

Head Connect Proxy

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

connect HEAD requests to proxy of Pod

HTTP Request

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

Path Parameters

Parameter Description
name name of the Pod
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
path Path is the URL path to use for the current proxy request to pod.

Response

Code Description
200
string
OK

Head Connect Proxy Path

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

connect HEAD requests to proxy of Pod

HTTP Request

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

Path Parameters

Parameter Description
name name of the Pod
namespace object name and auth scope, such as for teams and projects
path path to the resource

Query Parameters

Parameter Description
path Path is the URL path to use for the current proxy request to pod.

Response

Code Description
200
string
OK

Replace Connect Proxy

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

connect PUT requests to proxy of Pod

HTTP Request

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

Path Parameters

Parameter Description
name name of the Pod
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
path Path is the URL path to use for the current proxy request to pod.

Response

Code Description
200
string
OK

Replace Connect Proxy Path

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

connect PUT requests to proxy of Pod

HTTP Request

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

Path Parameters

Parameter Description
name name of the Pod
namespace object name and auth scope, such as for teams and projects
path path to the resource

Query Parameters

Parameter Description
path Path is the URL path to use for the current proxy request to pod.

Response

Code Description
200
string
OK

Replace Proxy

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

proxy PUT requests to Pod

HTTP Request

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

Path Parameters

Parameter Description
name name of the Pod
namespace object name and auth scope, such as for teams and projects

Response

Code Description
200
string
OK

Replace Proxy Path

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

proxy PUT requests to Pod

HTTP Request

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

Path Parameters

Parameter Description
name name of the Pod
namespace object name and auth scope, such as for teams and projects
path path to the resource

Response

Code Description
200
string
OK

Misc Operations

See supported operations below...

Read Log

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

read log of the specified Pod

HTTP Request

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

Path Parameters

Parameter Description
name name of the Pod
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
container The container for which to stream logs. Defaults to only container if there is one container in the pod.
follow Follow the log stream of the pod. Defaults to false.
limitBytes 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 If 'true', then the output is pretty printed.
previous Return previous terminated container logs. Defaults to false.
sinceSeconds 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 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 If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false.

Response

Code Description
200
string
OK

ReplicaSet v1beta1 extensions

ReplicaSet Config to run 3 nginx instances.


apiVersion: extensions/v1beta1
kind: ReplicaSet
metadata:
  # Unique key of the ReplicaSet instance
  name: replicaset-example
spec:
  # 3 Pods should exist at all times.
  replicas: 3
  template:
    metadata:
      labels:
        app: nginx
    spec:
      containers:
      # Run the nginx image
      - name: nginx
        image: nginx:1.10

ReplicaSet Config to run 3 nginx instances.


apiVersion: extensions/v1beta1
kind: ReplicaSet
metadata:
  # Unique key of the ReplicaSet instance
  name: replicaset-example
spec:
  # 3 Pods should exist at all times.
  replicas: 3
  template:
    metadata:
      labels:
        app: nginx
    spec:
      containers:
      # Run the nginx image
      - name: nginx
        image: nginx:1.10
Group Version Kind
extensions v1beta1 ReplicaSet

ReplicaSet represents the configuration of a ReplicaSet.

Field 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: http://releases.k8s.io/HEAD/docs/devel/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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec
ReplicaSetSpec
Spec defines the specification of the desired behavior of the ReplicaSet. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
status
ReplicaSetStatus
Status is the most recently observed status of the ReplicaSet. This data may be out of date by some window of time. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

ReplicaSetSpec v1beta1 extensions

Field Description
minReadySeconds
integer
Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
replicas
integer
Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: http://kubernetes.io/docs/user-guide/replication-controller#what-is-a-replication-controller
selector
LabelSelector
Selector is a label query over pods that should match the replica count. If the selector is empty, it is defaulted to the labels present on the pod template. Label keys and values that must match in order to be controlled by this replica set. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
template
PodTemplateSpec
Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: http://kubernetes.io/docs/user-guide/replication-controller#pod-template

ReplicaSetStatus v1beta1 extensions

Field Description
availableReplicas
integer
The number of available replicas (ready for at least minReadySeconds) for this replica set.
conditions
ReplicaSetCondition array
Represents the latest available observations of a replica set's current state.
fullyLabeledReplicas
integer
The number of pods that have labels matching the labels of the pod template of the replicaset.
observedGeneration
integer
ObservedGeneration reflects the generation of the most recently observed ReplicaSet.
readyReplicas
integer
The number of ready replicas for this replica set.
replicas
integer
Replicas is the most recently oberved number of replicas. More info: http://kubernetes.io/docs/user-guide/replication-controller#what-is-a-replication-controller

ReplicaSetList v1beta1 extensions

Field 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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items
ReplicaSet array
List of ReplicaSets. More info: http://kubernetes.io/docs/user-guide/replication-controller
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ListMeta
Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

Write Operations

See supported operations below...

Create

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

create a ReplicaSet

HTTP Request

POST /apis/extensions/v1beta1/namespaces/{namespace}/replicasets

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
ReplicaSet

Response

Code Description
200
ReplicaSet
OK

Replace

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

replace the specified ReplicaSet

HTTP Request

PUT /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}

Path Parameters

Parameter Description
name name of the ReplicaSet
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
ReplicaSet

Response

Code Description
200
ReplicaSet
OK

Patch

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

partially update the specified ReplicaSet

HTTP Request

PATCH /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}

Path Parameters

Parameter Description
name name of the ReplicaSet
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Patch

Response

Code Description
200
ReplicaSet
OK

Delete

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

delete a ReplicaSet

HTTP Request

DELETE /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}

Path Parameters

Parameter Description
name name of the ReplicaSet
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
gracePeriodSeconds 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 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 Whether and how garbage collection will be performed. Defaults to Default. Either this field or OrphanDependents may be set, but not both.

Body Parameters

Parameter Description
body
DeleteOptions

Response

Code Description
200
Status
OK

Delete Collection

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

delete collection of ReplicaSet

HTTP Request

DELETE /apis/extensions/v1beta1/namespaces/{namespace}/replicasets

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
Status
OK

Read Operations

See supported operations below...

Read

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

read the specified ReplicaSet

HTTP Request

GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}

Path Parameters

Parameter Description
name name of the ReplicaSet
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
exact Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
export Should this value be exported. Export strips fields that a user can not specify.

Response

Code Description
200
ReplicaSet
OK

List

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

list or watch objects of kind ReplicaSet

HTTP Request

GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
ReplicaSetList
OK

List All Namespaces

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

list or watch objects of kind ReplicaSet

HTTP Request

GET /apis/extensions/v1beta1/replicasets

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
ReplicaSetList
OK

Watch

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch changes to an object of kind ReplicaSet

HTTP Request

GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/replicasets/{name}

Path Parameters

Parameter Description
name name of the ReplicaSet
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Watch List

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch individual changes to a list of ReplicaSet

HTTP Request

GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/replicasets

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Watch List All Namespaces

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch individual changes to a list of ReplicaSet

HTTP Request

GET /apis/extensions/v1beta1/watch/replicasets

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Status Operations

See supported operations below...

Patch Status

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

partially update status of the specified ReplicaSet

HTTP Request

PATCH /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/status

Path Parameters

Parameter Description
name name of the ReplicaSet
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Patch

Response

Code Description
200
ReplicaSet
OK

Read Status

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

read status of the specified ReplicaSet

HTTP Request

GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/status

Path Parameters

Parameter Description
name name of the ReplicaSet
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Response

Code Description
200
ReplicaSet
OK

Replace Status

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

replace status of the specified ReplicaSet

HTTP Request

PUT /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/status

Path Parameters

Parameter Description
name name of the ReplicaSet
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
ReplicaSet

Response

Code Description
200
ReplicaSet
OK

Misc Operations

See supported operations below...

Read Scale

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

read scale of the specified Scale

HTTP Request

GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/scale

Path Parameters

Parameter Description
name name of the Scale
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Response

Code Description
200
Scale
OK

Replace Scale

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

replace scale of the specified Scale

HTTP Request

PUT /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/scale

Path Parameters

Parameter Description
name name of the Scale
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Scale

Response

Code Description
200
Scale
OK

Patch Scale

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

partially update scale of the specified Scale

HTTP Request

PATCH /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/scale

Path Parameters

Parameter Description
name name of the Scale
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Patch

Response

Code Description
200
Scale
OK

ReplicationController v1 core

ReplicationController Config to run 3 nginx instances.


apiVersion: v1
kind: ReplicationController
metadata:
  # Unique key of the ReplicationController instance
  name: replicationcontroller-example
spec:
  # 3 Pods should exist at all times.
  replicas: 3
  template:
    metadata:
      labels:
        app: nginx
    spec:
      containers:
      # Run the nginx image
      - name: nginx
        image: nginx:1.10

ReplicationController Config to run 3 nginx instances.


apiVersion: v1
kind: ReplicationController
metadata:
  # Unique key of the ReplicationController instance
  name: replicationcontroller-example
spec:
  # 3 Pods should exist at all times.
  replicas: 3
  template:
    metadata:
      labels:
        app: nginx
    spec:
      containers:
      # Run the nginx image
      - name: nginx
        image: nginx:1.10
Group Version Kind
Core v1 ReplicationController

ReplicationController represents the configuration of a replication controller.

Field 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: http://releases.k8s.io/HEAD/docs/devel/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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
If the Labels of a ReplicationController are empty, they are defaulted to be the same as the Pod(s) that the replication controller manages. Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec
ReplicationControllerSpec
Spec defines the specification of the desired behavior of the replication controller. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
status
ReplicationControllerStatus
Status is the most recently observed status of the replication controller. This data may be out of date by some window of time. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

ReplicationControllerSpec v1 core

Field Description
minReadySeconds
integer
Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
replicas
integer
Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: http://kubernetes.io/docs/user-guide/replication-controller#what-is-a-replication-controller
selector
object
Selector is a label query over pods that should match the Replicas count. If Selector is empty, it is defaulted to the labels present on the Pod template. Label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
template
PodTemplateSpec
Template is the object that describes the pod that will be created if insufficient replicas are detected. This takes precedence over a TemplateRef. More info: http://kubernetes.io/docs/user-guide/replication-controller#pod-template

ReplicationControllerStatus v1 core

Field Description
availableReplicas
integer
The number of available replicas (ready for at least minReadySeconds) for this replication controller.
conditions
ReplicationControllerCondition array
Represents the latest available observations of a replication controller's current state.
fullyLabeledReplicas
integer
The number of pods that have labels matching the labels of the pod template of the replication controller.
observedGeneration
integer
ObservedGeneration reflects the generation of the most recently observed replication controller.
readyReplicas
integer
The number of ready replicas for this replication controller.
replicas
integer
Replicas is the most recently oberved number of replicas. More info: http://kubernetes.io/docs/user-guide/replication-controller#what-is-a-replication-controller

ReplicationControllerList v1 core

Field 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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items
ReplicationController array
List of replication controllers. More info: http://kubernetes.io/docs/user-guide/replication-controller
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ListMeta
Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

Write Operations

See supported operations below...

Create

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

create a ReplicationController

HTTP Request

POST /api/v1/namespaces/{namespace}/replicationcontrollers

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
ReplicationController

Response

Code Description
200
ReplicationController
OK

Replace

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

replace the specified ReplicationController

HTTP Request

PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}

Path Parameters

Parameter Description
name name of the ReplicationController
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
ReplicationController

Response

Code Description
200
ReplicationController
OK

Patch

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

partially update the specified ReplicationController

HTTP Request

PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}

Path Parameters

Parameter Description
name name of the ReplicationController
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Patch

Response

Code Description
200
ReplicationController
OK

Delete

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

delete a ReplicationController

HTTP Request

DELETE /api/v1/namespaces/{namespace}/replicationcontrollers/{name}

Path Parameters

Parameter Description
name name of the ReplicationController
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
gracePeriodSeconds 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 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 Whether and how garbage collection will be performed. Defaults to Default. Either this field or OrphanDependents may be set, but not both.

Body Parameters

Parameter Description
body
DeleteOptions

Response

Code Description
200
Status
OK

Delete Collection

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

delete collection of ReplicationController

HTTP Request

DELETE /api/v1/namespaces/{namespace}/replicationcontrollers

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
Status
OK

Read Operations

See supported operations below...

Read

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

read the specified ReplicationController

HTTP Request

GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}

Path Parameters

Parameter Description
name name of the ReplicationController
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
exact Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
export Should this value be exported. Export strips fields that a user can not specify.

Response

Code Description
200
ReplicationController
OK

List

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

list or watch objects of kind ReplicationController

HTTP Request

GET /api/v1/namespaces/{namespace}/replicationcontrollers

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
ReplicationControllerList
OK

List All Namespaces

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

list or watch objects of kind ReplicationController

HTTP Request

GET /api/v1/replicationcontrollers

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
ReplicationControllerList
OK

Watch

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch changes to an object of kind ReplicationController

HTTP Request

GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers/{name}

Path Parameters

Parameter Description
name name of the ReplicationController
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Watch List

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch individual changes to a list of ReplicationController

HTTP Request

GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Watch List All Namespaces

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch individual changes to a list of ReplicationController

HTTP Request

GET /api/v1/watch/replicationcontrollers

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Status Operations

See supported operations below...

Patch Status

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

partially update status of the specified ReplicationController

HTTP Request

PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status

Path Parameters

Parameter Description
name name of the ReplicationController
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Patch

Response

Code Description
200
ReplicationController
OK

Read Status

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

read status of the specified ReplicationController

HTTP Request

GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status

Path Parameters

Parameter Description
name name of the ReplicationController
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Response

Code Description
200
ReplicationController
OK

Replace Status

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

replace status of the specified ReplicationController

HTTP Request

PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status

Path Parameters

Parameter Description
name name of the ReplicationController
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
ReplicationController

Response

Code Description
200
ReplicationController
OK

StatefulSet v1beta1 apps

Group Version Kind
apps v1beta1 StatefulSet

StatefulSet represents a set of pods with consistent identities. Identities are defined as:

Field 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: http://releases.k8s.io/HEAD/docs/devel/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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
StatefulSetSpec
Spec defines the desired identities of pods in this set.
status
StatefulSetStatus
Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time.

StatefulSetSpec v1beta1 apps

Field Description
replicas
integer
Replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.
selector
LabelSelector
Selector is a label query over pods that should match the replica count. If empty, defaulted to labels on the pod template. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
serviceName
string
ServiceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller.
template
PodTemplateSpec
Template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet.
volumeClaimTemplates
PersistentVolumeClaim array
VolumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.

StatefulSetStatus v1beta1 apps

Field Description
observedGeneration
integer
most recent generation observed by this StatefulSet.
replicas
integer
Replicas is the number of actual replicas.

StatefulSetList v1beta1 apps

Field 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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items
StatefulSet array
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ListMeta

Write Operations

See supported operations below...

Create

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

create a StatefulSet

HTTP Request

POST /apis/apps/v1beta1/namespaces/{namespace}/statefulsets

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
StatefulSet

Response

Code Description
200
StatefulSet
OK

Replace

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

replace the specified StatefulSet

HTTP Request

PUT /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}

Path Parameters

Parameter Description
name name of the StatefulSet
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
StatefulSet

Response

Code Description
200
StatefulSet
OK

Patch

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

partially update the specified StatefulSet

HTTP Request

PATCH /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}

Path Parameters

Parameter Description
name name of the StatefulSet
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Patch

Response

Code Description
200
StatefulSet
OK

Delete

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

delete a StatefulSet

HTTP Request

DELETE /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}

Path Parameters

Parameter Description
name name of the StatefulSet
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
gracePeriodSeconds 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 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 Whether and how garbage collection will be performed. Defaults to Default. Either this field or OrphanDependents may be set, but not both.

Body Parameters

Parameter Description
body
DeleteOptions

Response

Code Description
200
Status
OK

Delete Collection

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

delete collection of StatefulSet

HTTP Request

DELETE /apis/apps/v1beta1/namespaces/{namespace}/statefulsets

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
Status
OK

Read Operations

See supported operations below...

Read

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

read the specified StatefulSet

HTTP Request

GET /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}

Path Parameters

Parameter Description
name name of the StatefulSet
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
exact Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
export Should this value be exported. Export strips fields that a user can not specify.

Response

Code Description
200
StatefulSet
OK

List

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

list or watch objects of kind StatefulSet

HTTP Request

GET /apis/apps/v1beta1/namespaces/{namespace}/statefulsets

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
StatefulSetList
OK

List All Namespaces

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

list or watch objects of kind StatefulSet

HTTP Request

GET /apis/apps/v1beta1/statefulsets

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
StatefulSetList
OK

Watch

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch changes to an object of kind StatefulSet

HTTP Request

GET /apis/apps/v1beta1/watch/namespaces/{namespace}/statefulsets/{name}

Path Parameters

Parameter Description
name name of the StatefulSet
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Watch List

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch individual changes to a list of StatefulSet

HTTP Request

GET /apis/apps/v1beta1/watch/namespaces/{namespace}/statefulsets

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Watch List All Namespaces

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch individual changes to a list of StatefulSet

HTTP Request

GET /apis/apps/v1beta1/watch/statefulsets

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Status Operations

See supported operations below...

Patch Status

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

partially update status of the specified StatefulSet

HTTP Request

PATCH /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/status

Path Parameters

Parameter Description
name name of the StatefulSet
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Patch

Response

Code Description
200
StatefulSet
OK

Read Status

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

read status of the specified StatefulSet

HTTP Request

GET /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/status

Path Parameters

Parameter Description
name name of the StatefulSet
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Response

Code Description
200
StatefulSet
OK

Replace Status

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

replace status of the specified StatefulSet

HTTP Request

PUT /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/status

Path Parameters

Parameter Description
name name of the StatefulSet
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
StatefulSet

Response

Code Description
200
StatefulSet
OK

DISCOVERY & LOAD BALANCING

Discovery and Load Balancing resources are responsible for stitching your workloads together into an accessible Loadbalanced Service. By default, Workloads are only accessible within the cluster, and they must be exposed externally using a either a LoadBalancer or NodePort Service. For development, internally accessible Workloads can be accessed via proxy through the api master using the kubectl proxy command.

Common resource types:



Endpoints v1 core

Group Version Kind
Core v1 Endpoints

Endpoints is a collection of endpoints that implement the actual service. Example: Name: "mysvc", Subsets: [ { Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] }, { Addresses: [{"ip": "10.10.3.3"}], Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}] }, ]

Field 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: http://releases.k8s.io/HEAD/docs/devel/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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
subsets
EndpointSubset array
The set of all endpoints is the union of all subsets. Addresses are placed into subsets according to the IPs they share. A single address with multiple ports, some of which are ready and some of which are not (because they come from different containers) will result in the address being displayed in different subsets for the different ports. No address will appear in both Addresses and NotReadyAddresses in the same subset. Sets of addresses and ports that comprise a service.

EndpointsList v1 core

Field 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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items
Endpoints array
List of endpoints.
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ListMeta
Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

Write Operations

See supported operations below...

Create

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

create Endpoints

HTTP Request

POST /api/v1/namespaces/{namespace}/endpoints

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Endpoints

Response

Code Description
200
Endpoints
OK

Replace

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

replace the specified Endpoints

HTTP Request

PUT /api/v1/namespaces/{namespace}/endpoints/{name}

Path Parameters

Parameter Description
name name of the Endpoints
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Endpoints

Response

Code Description
200
Endpoints
OK

Patch

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

partially update the specified Endpoints

HTTP Request

PATCH /api/v1/namespaces/{namespace}/endpoints/{name}

Path Parameters

Parameter Description
name name of the Endpoints
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Patch

Response

Code Description
200
Endpoints
OK

Delete

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

delete Endpoints

HTTP Request

DELETE /api/v1/namespaces/{namespace}/endpoints/{name}

Path Parameters

Parameter Description
name name of the Endpoints
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
gracePeriodSeconds 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 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 Whether and how garbage collection will be performed. Defaults to Default. Either this field or OrphanDependents may be set, but not both.

Body Parameters

Parameter Description
body
DeleteOptions

Response

Code Description
200
Status
OK

Delete Collection

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

delete collection of Endpoints

HTTP Request

DELETE /api/v1/namespaces/{namespace}/endpoints

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
Status
OK

Read Operations

See supported operations below...

Read

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

read the specified Endpoints

HTTP Request

GET /api/v1/namespaces/{namespace}/endpoints/{name}

Path Parameters

Parameter Description
name name of the Endpoints
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
exact Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
export Should this value be exported. Export strips fields that a user can not specify.

Response

Code Description
200
Endpoints
OK

List

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

list or watch objects of kind Endpoints

HTTP Request

GET /api/v1/namespaces/{namespace}/endpoints

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
EndpointsList
OK

List All Namespaces

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

list or watch objects of kind Endpoints

HTTP Request

GET /api/v1/endpoints

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
EndpointsList
OK

Watch

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch changes to an object of kind Endpoints

HTTP Request

GET /api/v1/watch/namespaces/{namespace}/endpoints/{name}

Path Parameters

Parameter Description
name name of the Endpoints
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Watch List

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch individual changes to a list of Endpoints

HTTP Request

GET /api/v1/watch/namespaces/{namespace}/endpoints

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Watch List All Namespaces

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch individual changes to a list of Endpoints

HTTP Request

GET /api/v1/watch/endpoints

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Ingress v1beta1 extensions

Group Version Kind
extensions v1beta1 Ingress

Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc.

Field 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: http://releases.k8s.io/HEAD/docs/devel/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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec
IngressSpec
Spec is the desired state of the Ingress. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
status
IngressStatus
Status is the current state of the Ingress. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

IngressSpec v1beta1 extensions

Field Description
backend
IngressBackend
A default backend capable of servicing requests that don't match any rule. At least one of 'backend' or 'rules' must be specified. This field is optional to allow the loadbalancer controller or defaulting logic to specify a global default.
rules
IngressRule array
A list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend.
tls
IngressTLS array
TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI.

IngressStatus v1beta1 extensions

Field Description
loadBalancer
LoadBalancerStatus
LoadBalancer contains the current status of the load-balancer.

IngressList v1beta1 extensions

Field 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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items
Ingress array
Items is the list of Ingress.
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ListMeta
Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

Write Operations

See supported operations below...

Create

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

create an Ingress

HTTP Request

POST /apis/extensions/v1beta1/namespaces/{namespace}/ingresses

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Ingress

Response

Code Description
200
Ingress
OK

Replace

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

replace the specified Ingress

HTTP Request

PUT /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}

Path Parameters

Parameter Description
name name of the Ingress
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Ingress

Response

Code Description
200
Ingress
OK

Patch

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

partially update the specified Ingress

HTTP Request

PATCH /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}

Path Parameters

Parameter Description
name name of the Ingress
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Patch

Response

Code Description
200
Ingress
OK

Delete

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

delete an Ingress

HTTP Request

DELETE /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}

Path Parameters

Parameter Description
name name of the Ingress
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
gracePeriodSeconds 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 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 Whether and how garbage collection will be performed. Defaults to Default. Either this field or OrphanDependents may be set, but not both.

Body Parameters

Parameter Description
body
DeleteOptions

Response

Code Description
200
Status
OK

Delete Collection

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

delete collection of Ingress

HTTP Request

DELETE /apis/extensions/v1beta1/namespaces/{namespace}/ingresses

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
Status
OK

Read Operations

See supported operations below...

Read

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

read the specified Ingress

HTTP Request

GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}

Path Parameters

Parameter Description
name name of the Ingress
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
exact Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
export Should this value be exported. Export strips fields that a user can not specify.

Response

Code Description
200
Ingress
OK

List

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

list or watch objects of kind Ingress

HTTP Request

GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
IngressList
OK

List All Namespaces

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

list or watch objects of kind Ingress

HTTP Request

GET /apis/extensions/v1beta1/ingresses

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
IngressList
OK

Watch

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch changes to an object of kind Ingress

HTTP Request

GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/ingresses/{name}

Path Parameters

Parameter Description
name name of the Ingress
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Watch List

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch individual changes to a list of Ingress

HTTP Request

GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/ingresses

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Watch List All Namespaces

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch individual changes to a list of Ingress

HTTP Request

GET /apis/extensions/v1beta1/watch/ingresses

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Status Operations

See supported operations below...

Patch Status

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

partially update status of the specified Ingress

HTTP Request

PATCH /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status

Path Parameters

Parameter Description
name name of the Ingress
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Patch

Response

Code Description
200
Ingress
OK

Read Status

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

read status of the specified Ingress

HTTP Request

GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status

Path Parameters

Parameter Description
name name of the Ingress
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Response

Code Description
200
Ingress
OK

Replace Status

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

replace status of the specified Ingress

HTTP Request

PUT /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status

Path Parameters

Parameter Description
name name of the Ingress
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Ingress

Response

Code Description
200
Ingress
OK

Service v1 core

Service Config to load balance traffic across all Pods with the app=nginx label. Receives on and sends to port 80. Exposes an externally accessible endpoint.


kind: Service
apiVersion: v1
metadata:
  # Unique key of the Service instance
  name: service-example
spec:
  ports:
    # Accept traffic sent to port 80
    - name: http
      port: 80
      targetPort: 80
  selector:
    # Loadbalance traffic across Pods matching
    # this label selector
    app: nginx
  # Create an HA proxy in the cloud provider
  # with an External IP address - *Only supported
  # by some cloud providers*
  type: LoadBalancer

Service Config to load balance traffic across all Pods with the app=nginx label. Receives on and sends to port 80. Exposes an externally accessible endpoint.


kind: Service
apiVersion: v1
metadata:
  # Unique key of the Service instance
  name: service-example
spec:
  ports:
    # Accept traffic sent to port 80
    - name: http
      port: 80
      targetPort: 80
  selector:
    # Loadbalance traffic across Pods matching
    # this label selector
    app: nginx
  # Create an HA proxy in the cloud provider
  # with an External IP address - *Only supported
  # by some cloud providers*
  type: LoadBalancer
Group Version Kind
Core v1 Service

Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy.

Field 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: http://releases.k8s.io/HEAD/docs/devel/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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec
ServiceSpec
Spec defines the behavior of a service. http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
status
ServiceStatus
Most recently observed status of the service. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

ServiceSpec v1 core

Field Description
clusterIP
string
clusterIP is the IP address of the service and is usually assigned randomly by the master. If an address is specified manually and is not in use by others, it will be allocated to the service; otherwise, creation of the service will fail. This field can not be changed through updates. Valid values are "None", empty string (""), or a valid IP address. "None" can be specified for headless services when proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: http://kubernetes.io/docs/user-guide/services#virtual-ips-and-service-proxies
deprecatedPublicIPs
string array
deprecatedPublicIPs is deprecated and replaced by the externalIPs field with almost the exact same semantics. This field is retained in the v1 API for compatibility until at least 8/20/2016. It will be removed from any new API revisions. If both deprecatedPublicIPs and externalIPs are set, deprecatedPublicIPs is used.
externalIPs
string array
externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service. These IPs are not managed by Kubernetes. The user is responsible for ensuring that traffic arrives at a node with this IP. A common example is external load-balancers that are not part of the Kubernetes system. A previous form of this functionality exists as the deprecatedPublicIPs field. When using this field, callers should also clear the deprecatedPublicIPs field.
externalName
string
externalName is the external reference that kubedns or equivalent will return as a CNAME record for this service. No proxying will be involved. Must be a valid DNS name and requires Type to be ExternalName.
loadBalancerIP
string
Only applies to Service Type: LoadBalancer LoadBalancer will get created with the IP specified in this field. This feature depends on whether the underlying cloud-provider supports specifying the loadBalancerIP when a load balancer is created. This field will be ignored if the cloud-provider does not support the feature.
loadBalancerSourceRanges
string array
If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature." More info: http://kubernetes.io/docs/user-guide/services-firewalls
ports
ServicePort array
The list of ports that are exposed by this service. More info: http://kubernetes.io/docs/user-guide/services#virtual-ips-and-service-proxies
selector
object
Route service traffic to pods with label keys and values matching this selector. If empty or not present, the service is assumed to have an external process managing its endpoints, which Kubernetes will not modify. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: http://kubernetes.io/docs/user-guide/services#overview
sessionAffinity
string
Supports "ClientIP" and "None". Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info: http://kubernetes.io/docs/user-guide/services#virtual-ips-and-service-proxies
type
string
type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ExternalName" maps to the specified externalName. "ClusterIP" allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a stable IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the clusterIP. More info: http://kubernetes.io/docs/user-guide/services#overview

ServiceStatus v1 core

Field Description
loadBalancer
LoadBalancerStatus
LoadBalancer contains the current status of the load-balancer, if one is present.

ServiceList v1 core

Field 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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items
Service array
List of services
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ListMeta
Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

Write Operations

See supported operations below...

Create

kubectl Command


$ echo 'kind: Service
apiVersion: v1
metadata:
  name: service-example
spec:
  ports:
    - name: http
      port: 80
      targetPort: 80
  selector:
      app: nginx
  type: LoadBalancer
' | kubectl create -f -

curl Command (requires kubectl proxy to be running)


$ kubectl proxy
$ curl -X POST -H 'Content-Type: application/yaml' --data '
kind: Service
apiVersion: v1
metadata:
  name: service-example
spec:
  ports:
    - name: http
      port: 80
      targetPort: 80
  selector:
      app: nginx
  type: LoadBalancer
' http://127.0.0.1:8001/api/v1/namespaces/default/services

Output


service "service-example" created

Response Body


{
  "kind": "Service",
  "apiVersion": "v1",
  "metadata": {
    "name": "service-example",
    "namespace": "default",
    "selfLink": "/api/v1/namespaces/default/services/service-example",
    "uid": "93e5c731-9d30-11e6-9c54-42010a800148",
    "resourceVersion": "2205767",
    "creationTimestamp": "2016-10-28T17:04:24Z"
  },
  "spec": {
    "ports": [
      {
        "name": "http",
        "protocol": "TCP",
        "port": 80,
        "targetPort": 80,
        "nodePort": 32417
      }
    ],
    "selector": {
      "app": "nginx"
    },
    "clusterIP": "10.183.250.161",
    "type": "LoadBalancer",
    "sessionAffinity": "None"
  },
  "status": {
    "loadBalancer": {}
  }
}

create a Service

HTTP Request

POST /api/v1/namespaces/{namespace}/services

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Service

Response

Code Description
200
Service
OK

Replace

kubectl Command


$ echo 'apiVersion: v1
kind: Service
metadata:
  name: deployment-example
  resourceVersion: "2205995"
spec:
  clusterIP: 10.183.250.161
  ports:
  - name: http
    nodePort: 32417
    port: 80
    protocol: TCP
    targetPort: 8080
  selector:
    app: nginx
  sessionAffinity: None
  type: LoadBalancer
' | kubectl replace -f -

curl Command (requires kubectl proxy to be running)


$ kubectl proxy
$ curl -X PUT -H 'Content-Type: application/yaml' --data '
apiVersion: v1
kind: Service
metadata:
  name: deployment-example
  resourceVersion: "2205995"
spec:
  clusterIP: 10.183.250.161
  ports:
  - name: http
    nodePort: 32417
    port: 80
    protocol: TCP
    targetPort: 8080
  selector:
    app: nginx
  sessionAffinity: None
  type: LoadBalancer
' http://127.0.0.1:8001/api/v1/namespaces/default/services/deployment-example

Output


service "deployment-example" replaced

Response Body


{
  "kind": "Service",
  "apiVersion": "v1",
  "metadata": {
    "name": "deployment-example",
    "namespace": "default",
    "selfLink": "/api/v1/namespaces/default/services/deployment-example",
    "uid": "93e5c731-9d30-11e6-9c54-42010a800148",
    "resourceVersion": "2208672",
    "creationTimestamp": "2016-10-28T17:04:24Z"
  },
  "spec": {
    "ports": [
      {
        "name": "http",
        "protocol": "TCP",
        "port": 80,
        "targetPort": 8080,
        "nodePort": 32417
      }
    ],
    "selector": {
      "app": "nginx"
    },
    "clusterIP": "10.183.250.161",
    "type": "LoadBalancer",
    "sessionAffinity": "None"
  },
  "status": {
    "loadBalancer": {
      "ingress": [
        {
          "ip": "104.198.186.106"
        }
      ]
    }
  }
}

replace the specified Service

HTTP Request

PUT /api/v1/namespaces/{namespace}/services/{name}

Path Parameters

Parameter Description
name name of the Service
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Service

Response

Code Description
200
Service
OK

Patch

kubectl Command


$ kubectl patch service  -p \
    '{"spec":{"ports":[{"name":"http","port":80,"targetPort":8080}]}}'

curl Command (requires kubectl proxy to be running)


$ kubectl proxy
$ curl -X PATCH -H 'Content-Type: application/strategic-merge-patch+json' --data '
{"spec":{"ports":[{"name":"http","port":80,"targetPort":8080}]}}' \
    'http://127.0.0.1:8001/api/v1/namespaces/default/services/'

Output


"" patched

Response Body


{
  "kind": "Service",
  "apiVersion": "v1",
  "metadata": {
    "name": "deployment-example",
    "namespace": "default",
    "selfLink": "/api/v1/namespaces/default/services/deployment-example",
    "uid": "93e5c731-9d30-11e6-9c54-42010a800148",
    "resourceVersion": "2205995",
    "creationTimestamp": "2016-10-28T17:04:24Z"
  },
  "spec": {
    "ports": [
      {
        "name": "http",
        "protocol": "TCP",
        "port": 80,
        "targetPort": 8080,
        "nodePort": 32417
      }
    ],
    "selector": {
      "app": "nginx"
    },
    "clusterIP": "10.183.250.161",
    "type": "LoadBalancer",
    "sessionAffinity": "None"
  },
  "status": {
    "loadBalancer": {
      "ingress": [
        {
          "ip": "104.198.186.106"
        }
      ]
    }
  }
}

partially update the specified Service

HTTP Request

PATCH /api/v1/namespaces/{namespace}/services/{name}

Path Parameters

Parameter Description
name name of the Service
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Patch

Response

Code Description
200
Service
OK

Delete

kubectl Command


$ kubectl delete service deployment-example

curl Command (requires kubectl proxy to be running)


$ kubectl proxy
$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
gracePeriodSeconds: 0
orphanDependents: false
' 'http://127.0.0.1:8001/api/v1/namespaces/default/services/deployment-example'

Output


service "deployment-example" deleted

Response Body


{
  "kind": "Status",
  "apiVersion": "v1",
  "metadata": {},
  "status": "Success",
  "code": 200
}

delete a Service

HTTP Request

DELETE /api/v1/namespaces/{namespace}/services/{name}

Path Parameters

Parameter Description
name name of the Service
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Response

Code Description
200
Status
OK

Read Operations

See supported operations below...

Read

kubectl Command


$ kubectl get service deployment-example -o json

curl Command (requires kubectl proxy to be running)


$ kubectl proxy
$ curl -X GET http://127.0.0.1:8001/api/v1/namespaces/default/services/deployment-example

Output


{
  "kind": "Service",
  "apiVersion": "v1",
  "metadata": {
    "name": "deployment-example",
    "namespace": "default",
    "selfLink": "/api/v1/namespaces/default/services/deployment-example",
    "uid": "93e5c731-9d30-11e6-9c54-42010a800148",
    "resourceVersion": "2205995",
    "creationTimestamp": "2016-10-28T17:04:24Z"
  },
  "spec": {
    "ports": [
      {
        "name": "http",
        "protocol": "TCP",
        "port": 80,
        "targetPort": 8080,
        "nodePort": 32417
      }
    ],
    "selector": {
      "app": "nginx"
    },
    "clusterIP": "10.183.250.161",
    "type": "LoadBalancer",
    "sessionAffinity": "None"
  },
  "status": {
    "loadBalancer": {
      "ingress": [
        {
          "ip": "104.198.186.106"
        }
      ]
    }
  }
}

Response Body


{
  "kind": "Service",
  "apiVersion": "v1",
  "metadata": {
    "name": "deployment-example",
    "namespace": "default",
    "selfLink": "/api/v1/namespaces/default/services/deployment-example",
    "uid": "93e5c731-9d30-11e6-9c54-42010a800148",
    "resourceVersion": "2205995",
    "creationTimestamp": "2016-10-28T17:04:24Z"
  },
  "spec": {
    "ports": [
      {
        "name": "http",
        "protocol": "TCP",
        "port": 80,
        "targetPort": 8080,
        "nodePort": 32417
      }
    ],
    "selector": {
      "app": "nginx"
    },
    "clusterIP": "10.183.250.161",
    "type": "LoadBalancer",
    "sessionAffinity": "None"
  },
  "status": {
    "loadBalancer": {
      "ingress": [
        {
          "ip": "104.198.186.106"
        }
      ]
    }
  }
}

read the specified Service

HTTP Request

GET /api/v1/namespaces/{namespace}/services/{name}

Path Parameters

Parameter Description
name name of the Service
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
exact Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
export Should this value be exported. Export strips fields that a user can not specify.

Response

Code Description
200
Service
OK

List

kubectl Command


$ kubectl get service -o json

curl Command (requires kubectl proxy to be running)


$ kubectl proxy
$ curl -X GET 'http://127.0.0.1:8001/api/v1/namespaces/default/services'

Output


Response Body


list or watch objects of kind Service

HTTP Request

GET /api/v1/namespaces/{namespace}/services

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
ServiceList
OK

List All Namespaces

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

list or watch objects of kind Service

HTTP Request

GET /api/v1/services

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
ServiceList
OK

Watch

kubectl Command


$ kubectl get service deployment-example --watch -o json

curl Command (requires kubectl proxy to be running)


$ kubectl proxy
$ curl -X GET 'http://127.0.0.1:8001/api/v1/watch/namespaces/default/services/deployment-example'

Output


{
    "type": "ADDED",
    "object": {
        "kind": "Service",
        "apiVersion": "v1",
        "metadata": {
            "name": "deployment-example",
            "namespace": "default",
            "selfLink": "/api/v1/namespaces/default/services/deployment-example",
            "uid": "93e5c731-9d30-11e6-9c54-42010a800148",
            "resourceVersion": "2205995",
            "creationTimestamp": "2016-10-28T17:04:24Z"
        },
        "spec": {
            "ports": [
                {
                    "name": "http",
                    "protocol": "TCP",
                    "port": 80,
                    "targetPort": 8080,
                    "nodePort": 32417
                }
            ],
            "selector": {
                "app": "nginx"
            },
            "clusterIP": "10.183.250.161",
            "type": "LoadBalancer",
            "sessionAffinity": "None"
        },
        "status": {
            "loadBalancer": {
                "ingress": [
                    {
                        "ip": "104.198.186.106"
                    }
                ]
            }
        }
    }
}

Response Body


{
    "type": "ADDED",
    "object": {
        "kind": "Service",
        "apiVersion": "v1",
        "metadata": {
            "name": "deployment-example",
            "namespace": "default",
            "selfLink": "/api/v1/namespaces/default/services/deployment-example",
            "uid": "93e5c731-9d30-11e6-9c54-42010a800148",
            "resourceVersion": "2205995",
            "creationTimestamp": "2016-10-28T17:04:24Z"
        },
        "spec": {
            "ports": [
                {
                    "name": "http",
                    "protocol": "TCP",
                    "port": 80,
                    "targetPort": 8080,
                    "nodePort": 32417
                }
            ],
            "selector": {
                "app": "nginx"
            },
            "clusterIP": "10.183.250.161",
            "type": "LoadBalancer",
            "sessionAffinity": "None"
        },
        "status": {
            "loadBalancer": {
                "ingress": [
                    {
                        "ip": "104.198.186.106"
                    }
                ]
            }
        }
    }
}

watch changes to an object of kind Service

HTTP Request

GET /api/v1/watch/namespaces/{namespace}/services/{name}

Path Parameters

Parameter Description
name name of the Service
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Watch List

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch individual changes to a list of Service

HTTP Request

GET /api/v1/watch/namespaces/{namespace}/services

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Watch List All Namespaces

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch individual changes to a list of Service

HTTP Request

GET /api/v1/watch/services

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Status Operations

See supported operations below...

Patch Status

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

partially update status of the specified Service

HTTP Request

PATCH /api/v1/namespaces/{namespace}/services/{name}/status

Path Parameters

Parameter Description
name name of the Service
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Patch

Response

Code Description
200
Service
OK

Read Status

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

read status of the specified Service

HTTP Request

GET /api/v1/namespaces/{namespace}/services/{name}/status

Path Parameters

Parameter Description
name name of the Service
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Response

Code Description
200
Service
OK

Replace Status

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

replace status of the specified Service

HTTP Request

PUT /api/v1/namespaces/{namespace}/services/{name}/status

Path Parameters

Parameter Description
name name of the Service
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Service

Response

Code Description
200
Service
OK

Proxy Operations

See supported operations below...

Create Connect Proxy

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

connect POST requests to proxy of Service

HTTP Request

POST /api/v1/namespaces/{namespace}/services/{name}/proxy

Path Parameters

Parameter Description
name name of the Service
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
path Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

Response

Code Description
200
string
OK

Create Connect Proxy Path

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

connect POST requests to proxy of Service

HTTP Request

POST /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}

Path Parameters

Parameter Description
name name of the Service
namespace object name and auth scope, such as for teams and projects
path path to the resource

Query Parameters

Parameter Description
path Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

Response

Code Description
200
string
OK

Create Proxy

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

proxy POST requests to Service

HTTP Request

POST /api/v1/proxy/namespaces/{namespace}/services/{name}

Path Parameters

Parameter Description
name name of the Service
namespace object name and auth scope, such as for teams and projects

Response

Code Description
200
string
OK

Create Proxy Path

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

proxy POST requests to Service

HTTP Request

POST /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}

Path Parameters

Parameter Description
name name of the Service
namespace object name and auth scope, such as for teams and projects
path path to the resource

Response

Code Description
200
string
OK

Delete Connect Proxy

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

connect DELETE requests to proxy of Service

HTTP Request

DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy

Path Parameters

Parameter Description
name name of the Service
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
path Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

Response

Code Description
200
string
OK

Delete Connect Proxy Path

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

connect DELETE requests to proxy of Service

HTTP Request

DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}

Path Parameters

Parameter Description
name name of the Service
namespace object name and auth scope, such as for teams and projects
path path to the resource

Query Parameters

Parameter Description
path Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

Response

Code Description
200
string
OK

Delete Proxy

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

proxy DELETE requests to Service

HTTP Request

DELETE /api/v1/proxy/namespaces/{namespace}/services/{name}

Path Parameters

Parameter Description
name name of the Service
namespace object name and auth scope, such as for teams and projects

Response

Code Description
200
string
OK

Delete Proxy Path

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

proxy DELETE requests to Service

HTTP Request

DELETE /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}

Path Parameters

Parameter Description
name name of the Service
namespace object name and auth scope, such as for teams and projects
path path to the resource

Response

Code Description
200
string
OK

Get Connect Proxy

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

connect GET requests to proxy of Service

HTTP Request

GET /api/v1/namespaces/{namespace}/services/{name}/proxy

Path Parameters

Parameter Description
name name of the Service
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
path Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

Response

Code Description
200
string
OK

Get Connect Proxy Path

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

connect GET requests to proxy of Service

HTTP Request

GET /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}

Path Parameters

Parameter Description
name name of the Service
namespace object name and auth scope, such as for teams and projects
path path to the resource

Query Parameters

Parameter Description
path Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

Response

Code Description
200
string
OK

Get Proxy

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

proxy GET requests to Service

HTTP Request

GET /api/v1/proxy/namespaces/{namespace}/services/{name}

Path Parameters

Parameter Description
name name of the Service
namespace object name and auth scope, such as for teams and projects

Response

Code Description
200
string
OK

Get Proxy Path

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

proxy GET requests to Service

HTTP Request

GET /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}

Path Parameters

Parameter Description
name name of the Service
namespace object name and auth scope, such as for teams and projects
path path to the resource

Response

Code Description
200
string
OK

Head Connect Proxy

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

connect HEAD requests to proxy of Service

HTTP Request

HEAD /api/v1/namespaces/{namespace}/services/{name}/proxy

Path Parameters

Parameter Description
name name of the Service
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
path Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

Response

Code Description
200
string
OK

Head Connect Proxy Path

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

connect HEAD requests to proxy of Service

HTTP Request

HEAD /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}

Path Parameters

Parameter Description
name name of the Service
namespace object name and auth scope, such as for teams and projects
path path to the resource

Query Parameters

Parameter Description
path Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

Response

Code Description
200
string
OK

Replace Connect Proxy

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

connect PUT requests to proxy of Service

HTTP Request

PUT /api/v1/namespaces/{namespace}/services/{name}/proxy

Path Parameters

Parameter Description
name name of the Service
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
path Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

Response

Code Description
200
string
OK

Replace Connect Proxy Path

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

connect PUT requests to proxy of Service

HTTP Request

PUT /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}

Path Parameters

Parameter Description
name name of the Service
namespace object name and auth scope, such as for teams and projects
path path to the resource

Query Parameters

Parameter Description
path Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

Response

Code Description
200
string
OK

Replace Proxy

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

proxy PUT requests to Service

HTTP Request

PUT /api/v1/proxy/namespaces/{namespace}/services/{name}

Path Parameters

Parameter Description
name name of the Service
namespace object name and auth scope, such as for teams and projects

Response

Code Description
200
string
OK

Replace Proxy Path

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

proxy PUT requests to Service

HTTP Request

PUT /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}

Path Parameters

Parameter Description
name name of the Service
namespace object name and auth scope, such as for teams and projects
path path to the resource

Response

Code Description
200
string
OK

CONFIG & STORAGE

Config and Storage resources are responsible for injecting data into your applications and persisting data externally to your container.

Common resource types:



ConfigMap v1 core

Group Version Kind
Core v1 ConfigMap

ConfigMap holds configuration data for pods to consume.

Field 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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
data
object
Data contains the configuration data. Each key must be a valid DNS_SUBDOMAIN with an optional leading dot.
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

ConfigMapList v1 core

Field 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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items
ConfigMap array
Items is the list of ConfigMaps.
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ListMeta
More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

Write Operations

See supported operations below...

Create

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

create a ConfigMap

HTTP Request

POST /api/v1/namespaces/{namespace}/configmaps

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
ConfigMap

Response

Code Description
200
ConfigMap
OK

Replace

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

replace the specified ConfigMap

HTTP Request

PUT /api/v1/namespaces/{namespace}/configmaps/{name}

Path Parameters

Parameter Description
name name of the ConfigMap
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
ConfigMap

Response

Code Description
200
ConfigMap
OK

Patch

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

partially update the specified ConfigMap

HTTP Request

PATCH /api/v1/namespaces/{namespace}/configmaps/{name}

Path Parameters

Parameter Description
name name of the ConfigMap
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Patch

Response

Code Description
200
ConfigMap
OK

Delete

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

delete a ConfigMap

HTTP Request

DELETE /api/v1/namespaces/{namespace}/configmaps/{name}

Path Parameters

Parameter Description
name name of the ConfigMap
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
gracePeriodSeconds 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 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 Whether and how garbage collection will be performed. Defaults to Default. Either this field or OrphanDependents may be set, but not both.

Body Parameters

Parameter Description
body
DeleteOptions

Response

Code Description
200
Status
OK

Delete Collection

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

delete collection of ConfigMap

HTTP Request

DELETE /api/v1/namespaces/{namespace}/configmaps

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
Status
OK

Read Operations

See supported operations below...

Read

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

read the specified ConfigMap

HTTP Request

GET /api/v1/namespaces/{namespace}/configmaps/{name}

Path Parameters

Parameter Description
name name of the ConfigMap
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
exact Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
export Should this value be exported. Export strips fields that a user can not specify.

Response

Code Description
200
ConfigMap
OK

List

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

list or watch objects of kind ConfigMap

HTTP Request

GET /api/v1/namespaces/{namespace}/configmaps

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
ConfigMapList
OK

List All Namespaces

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

list or watch objects of kind ConfigMap

HTTP Request

GET /api/v1/configmaps

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
ConfigMapList
OK

Watch

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch changes to an object of kind ConfigMap

HTTP Request

GET /api/v1/watch/namespaces/{namespace}/configmaps/{name}

Path Parameters

Parameter Description
name name of the ConfigMap
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Watch List

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch individual changes to a list of ConfigMap

HTTP Request

GET /api/v1/watch/namespaces/{namespace}/configmaps

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Watch List All Namespaces

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch individual changes to a list of ConfigMap

HTTP Request

GET /api/v1/watch/configmaps

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Secret v1 core

Group Version Kind
Core v1 Secret

Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes.

Field 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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
data
object
Data contains the secret data. Each key must be a valid DNS_SUBDOMAIN or leading dot followed by valid DNS_SUBDOMAIN. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
stringData
object
stringData allows specifying non-binary secret data in string form. It is provided as a write-only convenience method. All keys and values are merged into the data field on write, overwriting any existing values. It is never output when reading from the API.
type
string
Used to facilitate programmatic handling of secret data.

SecretList v1 core

Field 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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items
Secret array
Items is a list of secret objects. More info: http://kubernetes.io/docs/user-guide/secrets
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ListMeta
Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

Write Operations

See supported operations below...

Create

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

create a Secret

HTTP Request

POST /api/v1/namespaces/{namespace}/secrets

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Secret

Response

Code Description
200
Secret
OK

Replace

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

replace the specified Secret

HTTP Request

PUT /api/v1/namespaces/{namespace}/secrets/{name}

Path Parameters

Parameter Description
name name of the Secret
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Secret

Response

Code Description
200
Secret
OK

Patch

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

partially update the specified Secret

HTTP Request

PATCH /api/v1/namespaces/{namespace}/secrets/{name}

Path Parameters

Parameter Description
name name of the Secret
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Patch

Response

Code Description
200
Secret
OK

Delete

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

delete a Secret

HTTP Request

DELETE /api/v1/namespaces/{namespace}/secrets/{name}

Path Parameters

Parameter Description
name name of the Secret
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
gracePeriodSeconds 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 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 Whether and how garbage collection will be performed. Defaults to Default. Either this field or OrphanDependents may be set, but not both.

Body Parameters

Parameter Description
body
DeleteOptions

Response

Code Description
200
Status
OK

Delete Collection

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

delete collection of Secret

HTTP Request

DELETE /api/v1/namespaces/{namespace}/secrets

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
Status
OK

Read Operations

See supported operations below...

Read

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

read the specified Secret

HTTP Request

GET /api/v1/namespaces/{namespace}/secrets/{name}

Path Parameters

Parameter Description
name name of the Secret
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
exact Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
export Should this value be exported. Export strips fields that a user can not specify.

Response

Code Description
200
Secret
OK

List

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

list or watch objects of kind Secret

HTTP Request

GET /api/v1/namespaces/{namespace}/secrets

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
SecretList
OK

List All Namespaces

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

list or watch objects of kind Secret

HTTP Request

GET /api/v1/secrets

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
SecretList
OK

Watch

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch changes to an object of kind Secret

HTTP Request

GET /api/v1/watch/namespaces/{namespace}/secrets/{name}

Path Parameters

Parameter Description
name name of the Secret
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Watch List

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch individual changes to a list of Secret

HTTP Request

GET /api/v1/watch/namespaces/{namespace}/secrets

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Watch List All Namespaces

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch individual changes to a list of Secret

HTTP Request

GET /api/v1/watch/secrets

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

PersistentVolumeClaim v1 core

Group Version Kind
Core v1 PersistentVolumeClaim

PersistentVolumeClaim is a user's request for and claim to a persistent volume

Field 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: http://releases.k8s.io/HEAD/docs/devel/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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec
PersistentVolumeClaimSpec
Spec defines the desired characteristics of a volume requested by a pod author. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistentvolumeclaims
status
PersistentVolumeClaimStatus
Status represents the current information/status of a persistent volume claim. Read-only. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistentvolumeclaims

PersistentVolumeClaimSpec v1 core

Field Description
accessModes
string array
AccessModes contains the desired access modes the volume should have. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#access-modes-1
resources
ResourceRequirements
Resources represents the minimum resources the volume should have. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#resources
selector
LabelSelector
A label query over volumes to consider for binding.
storageClassName
string
Name of the StorageClass required by the claim. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#class-1
volumeName
string
VolumeName is the binding reference to the PersistentVolume backing this claim.

PersistentVolumeClaimStatus v1 core

Field Description
accessModes
string array
AccessModes contains the actual access modes the volume backing the PVC has. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#access-modes-1
capacity
object
Represents the actual resources of the underlying volume.
phase
string
Phase represents the current phase of PersistentVolumeClaim.

PersistentVolumeClaimList v1 core

Field 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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items
PersistentVolumeClaim array
A list of persistent volume claims. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistentvolumeclaims
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ListMeta
Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

Write Operations

See supported operations below...

Create

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

create a PersistentVolumeClaim

HTTP Request

POST /api/v1/namespaces/{namespace}/persistentvolumeclaims

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
PersistentVolumeClaim

Response

Code Description
200
PersistentVolumeClaim
OK

Replace

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

replace the specified PersistentVolumeClaim

HTTP Request

PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}

Path Parameters

Parameter Description
name name of the PersistentVolumeClaim
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
PersistentVolumeClaim

Response

Code Description
200
PersistentVolumeClaim
OK

Patch

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

partially update the specified PersistentVolumeClaim

HTTP Request

PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}

Path Parameters

Parameter Description
name name of the PersistentVolumeClaim
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Patch

Response

Code Description
200
PersistentVolumeClaim
OK

Delete

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

delete a PersistentVolumeClaim

HTTP Request

DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}

Path Parameters

Parameter Description
name name of the PersistentVolumeClaim
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
gracePeriodSeconds 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 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 Whether and how garbage collection will be performed. Defaults to Default. Either this field or OrphanDependents may be set, but not both.

Body Parameters

Parameter Description
body
DeleteOptions

Response

Code Description
200
Status
OK

Delete Collection

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

delete collection of PersistentVolumeClaim

HTTP Request

DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
Status
OK

Read Operations

See supported operations below...

Read

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

read the specified PersistentVolumeClaim

HTTP Request

GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}

Path Parameters

Parameter Description
name name of the PersistentVolumeClaim
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
exact Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
export Should this value be exported. Export strips fields that a user can not specify.

Response

Code Description
200
PersistentVolumeClaim
OK

List

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

list or watch objects of kind PersistentVolumeClaim

HTTP Request

GET /api/v1/namespaces/{namespace}/persistentvolumeclaims

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
PersistentVolumeClaimList
OK

List All Namespaces

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

list or watch objects of kind PersistentVolumeClaim

HTTP Request

GET /api/v1/persistentvolumeclaims

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
PersistentVolumeClaimList
OK

Watch

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch changes to an object of kind PersistentVolumeClaim

HTTP Request

GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims/{name}

Path Parameters

Parameter Description
name name of the PersistentVolumeClaim
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Watch List

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch individual changes to a list of PersistentVolumeClaim

HTTP Request

GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Watch List All Namespaces

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch individual changes to a list of PersistentVolumeClaim

HTTP Request

GET /api/v1/watch/persistentvolumeclaims

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Status Operations

See supported operations below...

Patch Status

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

partially update status of the specified PersistentVolumeClaim

HTTP Request

PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status

Path Parameters

Parameter Description
name name of the PersistentVolumeClaim
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Patch

Response

Code Description
200
PersistentVolumeClaim
OK

Read Status

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

read status of the specified PersistentVolumeClaim

HTTP Request

GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status

Path Parameters

Parameter Description
name name of the PersistentVolumeClaim
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Response

Code Description
200
PersistentVolumeClaim
OK

Replace Status

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

replace status of the specified PersistentVolumeClaim

HTTP Request

PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status

Path Parameters

Parameter Description
name name of the PersistentVolumeClaim
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
PersistentVolumeClaim

Response

Code Description
200
PersistentVolumeClaim
OK

StorageClass v1 storage

Group Version Kind
storage v1 StorageClass

StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned.

StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name.

Field 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: http://releases.k8s.io/HEAD/docs/devel/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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
parameters
object
Parameters holds the parameters for the provisioner that should create volumes of this storage class.
provisioner
string
Provisioner indicates the type of the provisioner.

StorageClassList v1 storage

Field 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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items
StorageClass array
Items is the list of StorageClasses
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ListMeta
Standard list metadata More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

Write Operations

See supported operations below...

Create

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

create a StorageClass

HTTP Request

POST /apis/storage.k8s.io/v1/storageclasses

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
StorageClass

Response

Code Description
200
StorageClass
OK

Replace

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

replace the specified StorageClass

HTTP Request

PUT /apis/storage.k8s.io/v1/storageclasses/{name}

Path Parameters

Parameter Description
name name of the StorageClass

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
StorageClass

Response

Code Description
200
StorageClass
OK

Patch

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

partially update the specified StorageClass

HTTP Request

PATCH /apis/storage.k8s.io/v1/storageclasses/{name}

Path Parameters

Parameter Description
name name of the StorageClass

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Patch

Response

Code Description
200
StorageClass
OK

Delete

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

delete a StorageClass

HTTP Request

DELETE /apis/storage.k8s.io/v1/storageclasses/{name}

Path Parameters

Parameter Description
name name of the StorageClass

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
gracePeriodSeconds 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 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 Whether and how garbage collection will be performed. Defaults to Default. Either this field or OrphanDependents may be set, but not both.

Body Parameters

Parameter Description
body
DeleteOptions

Response

Code Description
200
Status
OK

Delete Collection

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

delete collection of StorageClass

HTTP Request

DELETE /apis/storage.k8s.io/v1/storageclasses

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
Status
OK

Read Operations

See supported operations below...

Read

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

read the specified StorageClass

HTTP Request

GET /apis/storage.k8s.io/v1/storageclasses/{name}

Path Parameters

Parameter Description
name name of the StorageClass

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
exact Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
export Should this value be exported. Export strips fields that a user can not specify.

Response

Code Description
200
StorageClass
OK

List

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

list or watch objects of kind StorageClass

HTTP Request

GET /apis/storage.k8s.io/v1/storageclasses

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
StorageClassList
OK

Watch

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch changes to an object of kind StorageClass

HTTP Request

GET /apis/storage.k8s.io/v1/watch/storageclasses/{name}

Path Parameters

Parameter Description
name name of the StorageClass

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Watch List

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch individual changes to a list of StorageClass

HTTP Request

GET /apis/storage.k8s.io/v1/watch/storageclasses

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Volume v1 core

Group Version Kind
Core v1 Volume

Volume represents a named volume in a pod that may be accessed by any container in the pod.

Field Description
awsElasticBlockStore
AWSElasticBlockStoreVolumeSource
AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore
azureDisk
AzureDiskVolumeSource
AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
azureFile
AzureFileVolumeSource
AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
cephfs
CephFSVolumeSource
CephFS represents a Ceph FS mount on the host that shares a pod's lifetime
cinder
CinderVolumeSource
Cinder represents a cinder volume attached and mounted on kubelets host machine More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md
configMap
ConfigMapVolumeSource
ConfigMap represents a configMap that should populate this volume
downwardAPI
DownwardAPIVolumeSource
DownwardAPI represents downward API about the pod that should populate this volume
emptyDir
EmptyDirVolumeSource
EmptyDir represents a temporary directory that shares a pod's lifetime. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir
fc
FCVolumeSource
FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
flexVolume
FlexVolumeSource
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.
flocker
FlockerVolumeSource
Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
gcePersistentDisk
GCEPersistentDiskVolumeSource
GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk
gitRepo
GitRepoVolumeSource
GitRepo represents a git repository at a particular revision.
glusterfs
GlusterfsVolumeSource
Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md
hostPath
HostPathVolumeSource
HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: http://kubernetes.io/docs/user-guide/volumes#hostpath
iscsi
ISCSIVolumeSource
ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: http://releases.k8s.io/HEAD/examples/volumes/iscsi/README.md
name
string
Volume's name. Must be a DNS_LABEL and unique within the pod. More info: http://kubernetes.io/docs/user-guide/identifiers#names
nfs
NFSVolumeSource
NFS represents an NFS mount on the host that shares a pod's lifetime More info: http://kubernetes.io/docs/user-guide/volumes#nfs
persistentVolumeClaim
PersistentVolumeClaimVolumeSource
PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistentvolumeclaims
photonPersistentDisk
PhotonPersistentDiskVolumeSource
PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
portworxVolume
PortworxVolumeSource
PortworxVolume represents a portworx volume attached and mounted on kubelets host machine
projected
ProjectedVolumeSource
Items for all in one resources secrets, configmaps, and downward API
quobyte
QuobyteVolumeSource
Quobyte represents a Quobyte mount on the host that shares a pod's lifetime
rbd
RBDVolumeSource
RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md
scaleIO
ScaleIOVolumeSource
ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
secret
SecretVolumeSource
Secret represents a secret that should populate this volume. More info: http://kubernetes.io/docs/user-guide/volumes#secrets
vsphereVolume
VsphereVirtualDiskVolumeSource
VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

METADATA

Metadata resources are responsible for configuring behavior of your other Resources within the Cluster.

Common resource types:



Event v1 core

Group Version Kind
Core v1 Event

Event is a report of an event somewhere in the cluster.

Field 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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
count
integer
The number of times this event has occurred.
firstTimestamp
Time
The time at which the event was first recorded. (Time of server receipt is in TypeMeta.)
involvedObject
ObjectReference
The object that this event is about.
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
lastTimestamp
Time
The time at which the most recent occurrence of this event was recorded.
message
string
A human-readable description of the status of this operation.
metadata
ObjectMeta
Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
reason
string
This should be a short, machine understandable string that gives the reason for the transition into the object's current status.
source
EventSource
The component reporting this event. Should be a short machine understandable string.
type
string
Type of this event (Normal, Warning), new types could be added in the future

EventList v1 core

Field 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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items
Event array
List of events
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ListMeta
Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

Write Operations

See supported operations below...

Create

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

create an Event

HTTP Request

POST /api/v1/namespaces/{namespace}/events

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Event

Response

Code Description
200
Event
OK

Replace

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

replace the specified Event

HTTP Request

PUT /api/v1/namespaces/{namespace}/events/{name}

Path Parameters

Parameter Description
name name of the Event
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Event

Response

Code Description
200
Event
OK

Patch

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

partially update the specified Event

HTTP Request

PATCH /api/v1/namespaces/{namespace}/events/{name}

Path Parameters

Parameter Description
name name of the Event
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Patch

Response

Code Description
200
Event
OK

Delete

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

delete an Event

HTTP Request

DELETE /api/v1/namespaces/{namespace}/events/{name}

Path Parameters

Parameter Description
name name of the Event
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
gracePeriodSeconds 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 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 Whether and how garbage collection will be performed. Defaults to Default. Either this field or OrphanDependents may be set, but not both.

Body Parameters

Parameter Description
body
DeleteOptions

Response

Code Description
200
Status
OK

Delete Collection

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

delete collection of Event

HTTP Request

DELETE /api/v1/namespaces/{namespace}/events

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
Status
OK

Read Operations

See supported operations below...

Read

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

read the specified Event

HTTP Request

GET /api/v1/namespaces/{namespace}/events/{name}

Path Parameters

Parameter Description
name name of the Event
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
exact Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
export Should this value be exported. Export strips fields that a user can not specify.

Response

Code Description
200
Event
OK

List

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

list or watch objects of kind Event

HTTP Request

GET /api/v1/namespaces/{namespace}/events

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
EventList
OK

List All Namespaces

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

list or watch objects of kind Event

HTTP Request

GET /api/v1/events

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
EventList
OK

Watch

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch changes to an object of kind Event

HTTP Request

GET /api/v1/watch/namespaces/{namespace}/events/{name}

Path Parameters

Parameter Description
name name of the Event
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Watch List

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch individual changes to a list of Event

HTTP Request

GET /api/v1/watch/namespaces/{namespace}/events

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Watch List All Namespaces

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch individual changes to a list of Event

HTTP Request

GET /api/v1/watch/events

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

LimitRange v1 core

Group Version Kind
Core v1 LimitRange

LimitRange sets resource usage limits for each kind of resource in a Namespace.

Field 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: http://releases.k8s.io/HEAD/docs/devel/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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec
LimitRangeSpec
Spec defines the limits enforced. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

LimitRangeSpec v1 core

Field Description
limits
LimitRangeItem array
Limits is the list of LimitRangeItem objects that are enforced.

LimitRangeList v1 core

Field 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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items
LimitRange array
Items is a list of LimitRange objects. More info: http://releases.k8s.io/HEAD/docs/design/admission_control_limit_range.md
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ListMeta
Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

Write Operations

See supported operations below...

Create

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

create a LimitRange

HTTP Request

POST /api/v1/namespaces/{namespace}/limitranges

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
LimitRange

Response

Code Description
200
LimitRange
OK

Replace

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

replace the specified LimitRange

HTTP Request

PUT /api/v1/namespaces/{namespace}/limitranges/{name}

Path Parameters

Parameter Description
name name of the LimitRange
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
LimitRange

Response

Code Description
200
LimitRange
OK

Patch

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

partially update the specified LimitRange

HTTP Request

PATCH /api/v1/namespaces/{namespace}/limitranges/{name}

Path Parameters

Parameter Description
name name of the LimitRange
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Patch

Response

Code Description
200
LimitRange
OK

Delete

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

delete a LimitRange

HTTP Request

DELETE /api/v1/namespaces/{namespace}/limitranges/{name}

Path Parameters

Parameter Description
name name of the LimitRange
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
gracePeriodSeconds 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 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 Whether and how garbage collection will be performed. Defaults to Default. Either this field or OrphanDependents may be set, but not both.

Body Parameters

Parameter Description
body
DeleteOptions

Response

Code Description
200
Status
OK

Delete Collection

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

delete collection of LimitRange

HTTP Request

DELETE /api/v1/namespaces/{namespace}/limitranges

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
Status
OK

Read Operations

See supported operations below...

Read

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

read the specified LimitRange

HTTP Request

GET /api/v1/namespaces/{namespace}/limitranges/{name}

Path Parameters

Parameter Description
name name of the LimitRange
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
exact Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
export Should this value be exported. Export strips fields that a user can not specify.

Response

Code Description
200
LimitRange
OK

List

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

list or watch objects of kind LimitRange

HTTP Request

GET /api/v1/namespaces/{namespace}/limitranges

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
LimitRangeList
OK

List All Namespaces

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

list or watch objects of kind LimitRange

HTTP Request

GET /api/v1/limitranges

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
LimitRangeList
OK

Watch

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch changes to an object of kind LimitRange

HTTP Request

GET /api/v1/watch/namespaces/{namespace}/limitranges/{name}

Path Parameters

Parameter Description
name name of the LimitRange
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Watch List

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch individual changes to a list of LimitRange

HTTP Request

GET /api/v1/watch/namespaces/{namespace}/limitranges

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Watch List All Namespaces

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch individual changes to a list of LimitRange

HTTP Request

GET /api/v1/watch/limitranges

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

HorizontalPodAutoscaler v1 autoscaling

Group Version Kind
autoscaling v1 HorizontalPodAutoscaler

configuration of a horizontal pod autoscaler.

Field 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: http://releases.k8s.io/HEAD/docs/devel/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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
Standard object metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec
HorizontalPodAutoscalerSpec
behaviour of autoscaler. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status.
status
HorizontalPodAutoscalerStatus
current information about the autoscaler.

HorizontalPodAutoscalerSpec v1 autoscaling

Field Description
maxReplicas
integer
upper limit for the number of pods that can be set by the autoscaler; cannot be smaller than MinReplicas.
minReplicas
integer
lower limit for the number of pods that can be set by the autoscaler, default 1.
scaleTargetRef
CrossVersionObjectReference
reference to scaled resource; horizontal pod autoscaler will learn the current resource consumption and will set the desired number of pods by using its Scale subresource.
targetCPUUtilizationPercentage
integer
target average CPU utilization (represented as a percentage of requested CPU) over all the pods; if not specified the default autoscaling policy will be used.

HorizontalPodAutoscalerStatus v1 autoscaling

Field Description
currentCPUUtilizationPercentage
integer
current average CPU utilization over all pods, represented as a percentage of requested CPU, e.g. 70 means that an average pod is using now 70% of its requested CPU.
currentReplicas
integer
current number of replicas of pods managed by this autoscaler.
desiredReplicas
integer
desired number of replicas of pods managed by this autoscaler.
lastScaleTime
Time
last time the HorizontalPodAutoscaler scaled the number of pods; used by the autoscaler to control how often the number of pods is changed.
observedGeneration
integer
most recent generation observed by this autoscaler.

HorizontalPodAutoscalerList v1 autoscaling

Field 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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items
HorizontalPodAutoscaler array
list of horizontal pod autoscaler objects.
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ListMeta
Standard list metadata.

Write Operations

See supported operations below...

Create

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

create a HorizontalPodAutoscaler

HTTP Request

POST /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
HorizontalPodAutoscaler

Response

Code Description
200
HorizontalPodAutoscaler
OK

Replace

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

replace the specified HorizontalPodAutoscaler

HTTP Request

PUT /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}

Path Parameters

Parameter Description
name name of the HorizontalPodAutoscaler
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
HorizontalPodAutoscaler

Response

Code Description
200
HorizontalPodAutoscaler
OK

Patch

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

partially update the specified HorizontalPodAutoscaler

HTTP Request

PATCH /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}

Path Parameters

Parameter Description
name name of the HorizontalPodAutoscaler
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Patch

Response

Code Description
200
HorizontalPodAutoscaler
OK

Delete

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

delete a HorizontalPodAutoscaler

HTTP Request

DELETE /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}

Path Parameters

Parameter Description
name name of the HorizontalPodAutoscaler
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
gracePeriodSeconds 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 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 Whether and how garbage collection will be performed. Defaults to Default. Either this field or OrphanDependents may be set, but not both.

Body Parameters

Parameter Description
body
DeleteOptions

Response

Code Description
200
Status
OK

Delete Collection

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

delete collection of HorizontalPodAutoscaler

HTTP Request

DELETE /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
Status
OK

Read Operations

See supported operations below...

Read

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

read the specified HorizontalPodAutoscaler

HTTP Request

GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}

Path Parameters

Parameter Description
name name of the HorizontalPodAutoscaler
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
exact Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
export Should this value be exported. Export strips fields that a user can not specify.

Response

Code Description
200
HorizontalPodAutoscaler
OK

List

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

list or watch objects of kind HorizontalPodAutoscaler

HTTP Request

GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
HorizontalPodAutoscalerList
OK

List All Namespaces

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

list or watch objects of kind HorizontalPodAutoscaler

HTTP Request

GET /apis/autoscaling/v1/horizontalpodautoscalers

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
HorizontalPodAutoscalerList
OK

Watch

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch changes to an object of kind HorizontalPodAutoscaler

HTTP Request

GET /apis/autoscaling/v1/watch/namespaces/{namespace}/horizontalpodautoscalers/{name}

Path Parameters

Parameter Description
name name of the HorizontalPodAutoscaler
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Watch List

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch individual changes to a list of HorizontalPodAutoscaler

HTTP Request

GET /apis/autoscaling/v1/watch/namespaces/{namespace}/horizontalpodautoscalers

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Watch List All Namespaces

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch individual changes to a list of HorizontalPodAutoscaler

HTTP Request

GET /apis/autoscaling/v1/watch/horizontalpodautoscalers

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
WatchEvent
OK

Status Operations

See supported operations below...

Patch Status

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

partially update status of the specified HorizontalPodAutoscaler

HTTP Request

PATCH /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status

Path Parameters

Parameter Description
name name of the HorizontalPodAutoscaler
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Patch

Response

Code Description
200
HorizontalPodAutoscaler
OK

Read Status

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

read status of the specified HorizontalPodAutoscaler

HTTP Request

GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status

Path Parameters

Parameter Description
name name of the HorizontalPodAutoscaler
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Response

Code Description
200
HorizontalPodAutoscaler
OK

Replace Status

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

replace status of the specified HorizontalPodAutoscaler

HTTP Request

PUT /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status

Path Parameters

Parameter Description
name name of the HorizontalPodAutoscaler
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
HorizontalPodAutoscaler

Response

Code Description
200
HorizontalPodAutoscaler
OK

PodTemplate v1 core

Group Version Kind
Core v1 PodTemplate

PodTemplate describes a template for creating copies of a predefined pod.

Field 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: http://releases.k8s.io/HEAD/docs/devel/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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
template
PodTemplateSpec
Template defines the pods that will be created from this pod template. http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

PodTemplateSpec v1 core

Field Description
metadata
ObjectMeta
Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec
PodSpec
Specification of the desired behavior of the pod. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

PodTemplateList v1 core

Field 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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items
PodTemplate array
List of pod templates
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ListMeta
Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

Write Operations

See supported operations below...

Create

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

create a PodTemplate

HTTP Request

POST /api/v1/namespaces/{namespace}/podtemplates

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
PodTemplate

Response

Code Description
200
PodTemplate
OK

Replace

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

replace the specified PodTemplate

HTTP Request

PUT /api/v1/namespaces/{namespace}/podtemplates/{name}

Path Parameters

Parameter Description
name name of the PodTemplate
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
PodTemplate

Response

Code Description
200
PodTemplate
OK

Patch

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

partially update the specified PodTemplate

HTTP Request

PATCH /api/v1/namespaces/{namespace}/podtemplates/{name}

Path Parameters

Parameter Description
name name of the PodTemplate
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Patch

Response

Code Description
200
PodTemplate
OK

Delete

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

delete a PodTemplate

HTTP Request

DELETE /api/v1/namespaces/{namespace}/podtemplates/{name}

Path Parameters

Parameter Description
name name of the PodTemplate
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
gracePeriodSeconds 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 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 Whether and how garbage collection will be performed. Defaults to Default. Either this field or OrphanDependents may be set, but not both.

Body Parameters

Parameter Description
body
DeleteOptions

Response

Code Description
200
Status
OK

Delete Collection

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

delete collection of PodTemplate

HTTP Request

DELETE /api/v1/namespaces/{namespace}/podtemplates

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
Status
OK

Read Operations

See supported operations below...

Read

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

read the specified PodTemplate

HTTP Request

GET /api/v1/namespaces/{namespace}/podtemplates/{name}

Path Parameters

Parameter Description
name name of the PodTemplate
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
exact Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
export Should this value be exported. Export strips fields that a user can not specify.

Response

Code Description
200
PodTemplate
OK

List

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

list or watch objects of kind PodTemplate

HTTP Request

GET /api/v1/namespaces/{namespace}/podtemplates

Path Parameters

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
PodTemplateList
OK

List All Namespaces

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

list or watch objects of kind PodTemplate

HTTP Request

GET /api/v1/podtemplates

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
PodTemplateList
OK

Watch

kubectl Command


Coming Soon

curl Command (requires kubectl proxy to be running)


Coming Soon

Output


Coming Soon

Response Body


Coming Soon

watch changes to an object of kind PodTemplate

HTTP Request

GET /api/v1/watch/namespaces/{namespace}/podtemplates/{name}

Path Parameters

Parameter Description
name name of the PodTemplate
namespace object name and auth scope, such as for teams and projects

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty If 'true', then the output is pretty printed.
resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200