Chapter 3. Kubernetes v1 REST API

3.1. Overview
Copy link

The Kubernetes API allows you to run containerized applications, bind persistent storage, link those applications through service discovery, and manage the cluster infrastructure.

3.1.1. Version information
Copy link

Version: v1

3.1.2. URI scheme
Copy link

Host: 127.0.0.1:8443
BasePath: /
Schemes: HTTPS

HTTP Code	Description	Schema
200	success	Section 3.3.96, “v1.ComponentStatusList”

HTTP Code	Description	Schema
200	success	Section 3.3.53, “v1.EndpointsList”

HTTP Code	Description	Schema
200	success	Section 3.3.89, “v1.Endpoints”

HTTP Code	Description	Schema
200	success	Section 3.3.79, “v1.EventList”

HTTP Code	Description	Schema
200	success	Section 3.3.9, “v1.Event”

HTTP Code	Description	Schema
200	success	Section 3.3.41, “v1.LimitRangeList”

HTTP Code	Description	Schema
200	success	Section 3.3.113, “v1.LimitRange”

HTTP Code	Description	Schema
200	success	Section 3.3.60, “v1.NamespaceList”

HTTP Code	Description	Schema
200	success	Section 3.3.96, “v1.ComponentStatusList”

HTTP Code	Description	Schema
200	success	Section 3.3.82, “v1.ComponentStatus”

HTTP Code	Description	Schema
200	success	Section 3.3.53, “v1.EndpointsList”

HTTP Code	Description	Schema
200	success	Section 3.3.89, “v1.Endpoints”

HTTP Code	Description	Schema
200	success	Section 3.3.89, “v1.Endpoints”

HTTP Code	Description	Schema
200	success	Section 3.3.89, “v1.Endpoints”

HTTP Code	Description	Schema
200	success	Section 3.3.89, “v1.Endpoints”

HTTP Code	Description	Schema
200	success	Section 3.3.79, “v1.EventList”

HTTP Code	Description	Schema
200	success	Section 3.3.9, “v1.Event”

HTTP Code	Description	Schema
200	success	Section 3.3.9, “v1.Event”

HTTP Code	Description	Schema
200	success	Section 3.3.9, “v1.Event”

HTTP Code	Description	Schema
200	success	Section 3.3.9, “v1.Event”

Persistent Volume Claims (PVC) represent a request to use a persistent volume (PV) with a pod. When creating a pod definition (or replication controller or deployment config) a developer may specify the amount of storage they need via a persistent volume reference. If an administrator has enabled and configured persistent volumes for use, they will be allocated on demand to pods that have similar requirements. Since volumes are created lazily, some pods may be scheduled to a node before their volume is assigned. The node will detect this situation and wait to start the pod until the volume is bound. Events will be generated (visible by using the describe command on the pod) that indicate the pod is waiting for volumes.

3.2.32.2. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.32.3. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.81, “v1.PersistentVolumeClaimList”

3.2.32.4. Consumes
Copy link

3.2.32.5. Produces
Copy link

application/json

3.2.32.6. Tags
Copy link

apiv1

3.2.33. create a PersistentVolumeClaim
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.33.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.24, “v1.PersistentVolumeClaim”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.33.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.24, “v1.PersistentVolumeClaim”

3.2.33.3. Consumes
Copy link

3.2.33.4. Produces
Copy link

application/json

3.2.33.5. Tags
Copy link

apiv1

3.2.34. read the specified PersistentVolumeClaim
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.34.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the PersistentVolumeClaim	true	string

3.2.34.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.24, “v1.PersistentVolumeClaim”

3.2.34.3. Consumes
Copy link

3.2.34.4. Produces
Copy link

application/json

3.2.34.5. Tags
Copy link

apiv1

3.2.35. replace the specified PersistentVolumeClaim
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.35.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.24, “v1.PersistentVolumeClaim”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the PersistentVolumeClaim	true	string

3.2.35.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.24, “v1.PersistentVolumeClaim”

3.2.35.3. Consumes
Copy link

3.2.35.4. Produces
Copy link

application/json

3.2.35.5. Tags
Copy link

apiv1

3.2.36. delete a PersistentVolumeClaim
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.36.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.23, “v1.DeleteOptions”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the PersistentVolumeClaim	true	string

3.2.36.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.132, “v1.Status”

3.2.36.3. Consumes
Copy link

3.2.36.4. Produces
Copy link

application/json

3.2.36.5. Tags
Copy link

apiv1

3.2.37. partially update the specified PersistentVolumeClaim
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.37.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.98, “api.Patch”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the PersistentVolumeClaim	true	string

3.2.37.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.24, “v1.PersistentVolumeClaim”

3.2.37.3. Consumes
Copy link

application/json-patch+json
application/merge-patch+json
application/strategic-merge-patch+json

3.2.37.4. Produces
Copy link

application/json

3.2.37.5. Tags
Copy link

apiv1

3.2.38. replace status of the specified PersistentVolumeClaim
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.38.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.24, “v1.PersistentVolumeClaim”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the PersistentVolumeClaim	true	string

3.2.38.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.24, “v1.PersistentVolumeClaim”

3.2.38.3. Consumes
Copy link

3.2.38.4. Produces
Copy link

application/json

3.2.38.5. Tags
Copy link

apiv1

3.2.39. list or watch objects of kind Pod
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.39.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.39.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.69, “v1.PodList”

3.2.39.3. Consumes
Copy link

3.2.39.4. Produces
Copy link

application/json

3.2.39.5. Tags
Copy link

apiv1

3.2.40. create a Pod
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.40.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.8, “v1.Pod”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.40.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.8, “v1.Pod”

3.2.40.3. Consumes
Copy link

3.2.40.4. Produces
Copy link

application/json

3.2.40.5. Tags
Copy link

apiv1

3.2.41. read the specified Pod
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.41.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.41.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.8, “v1.Pod”

3.2.41.3. Consumes
Copy link

3.2.41.4. Produces
Copy link

application/json

3.2.41.5. Tags
Copy link

apiv1

3.2.42. replace the specified Pod
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.42.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.8, “v1.Pod”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.42.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.8, “v1.Pod”

3.2.42.3. Consumes
Copy link

3.2.42.4. Produces
Copy link

application/json

3.2.42.5. Tags
Copy link

apiv1

3.2.43. delete a Pod
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.43.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.23, “v1.DeleteOptions”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.43.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.132, “v1.Status”

3.2.43.3. Consumes
Copy link

3.2.43.4. Produces
Copy link

application/json

3.2.43.5. Tags
Copy link

apiv1

3.2.44. partially update the specified Pod
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.44.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.98, “api.Patch”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.44.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.8, “v1.Pod”

3.2.44.3. Consumes
Copy link

application/json-patch+json
application/merge-patch+json
application/strategic-merge-patch+json

3.2.44.4. Produces
Copy link

application/json

3.2.44.5. Tags
Copy link

apiv1

3.2.45. connect GET requests to attach of Pod
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.45.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	stdin	redirect the standard input stream of the pod for this call; defaults to false	false	boolean
QueryParameter	stdout	redirect the standard output stream of the pod for this call; defaults to true	false	boolean
QueryParameter	stderr	redirect the standard error stream of the pod for this call; defaults to true	false	boolean
QueryParameter	tty	allocate a terminal for this attach call; defaults to false	false	boolean
QueryParameter	container	the container in which to execute the command. Defaults to only container if there is only one container in the pod.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.45.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
default	success	string

3.2.45.3. Consumes
Copy link

3.2.45.4. Produces
Copy link

3.2.45.5. Tags
Copy link

apiv1

3.2.46. connect POST requests to attach of Pod
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.46.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	stdin	redirect the standard input stream of the pod for this call; defaults to false	false	boolean
QueryParameter	stdout	redirect the standard output stream of the pod for this call; defaults to true	false	boolean
QueryParameter	stderr	redirect the standard error stream of the pod for this call; defaults to true	false	boolean
QueryParameter	tty	allocate a terminal for this attach call; defaults to false	false	boolean
QueryParameter	container	the container in which to execute the command. Defaults to only container if there is only one container in the pod.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.46.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
default	success	string

3.2.46.3. Consumes
Copy link

3.2.46.4. Produces
Copy link

3.2.46.5. Tags
Copy link

apiv1

3.2.47. create binding of a Binding
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.47.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.103, “v1.Binding”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Binding	true	string

3.2.47.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.103, “v1.Binding”

3.2.47.3. Consumes
Copy link

3.2.47.4. Produces
Copy link

application/json

3.2.47.5. Tags
Copy link

apiv1

3.2.48. connect GET requests to exec of Pod
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.48.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	stdin	redirect the standard input stream of the pod for this call; defaults to false	false	boolean
QueryParameter	stdout	redirect the standard output stream of the pod for this call; defaults to true	false	boolean
QueryParameter	stderr	redirect the standard error stream of the pod for this call; defaults to true	false	boolean
QueryParameter	tty	allocate a terminal for this exec call; defaults to false	false	boolean
QueryParameter	container	the container in which to execute the command. Defaults to only container if there is only one container in the pod.	false	string
QueryParameter	command	the command to execute; argv array; not executed within a shell	false	ref
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.48.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
default	success	string

3.2.48.3. Consumes
Copy link

3.2.48.4. Produces
Copy link

3.2.48.5. Tags
Copy link

apiv1

3.2.49. connect POST requests to exec of Pod
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.49.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	stdin	redirect the standard input stream of the pod for this call; defaults to false	false	boolean
QueryParameter	stdout	redirect the standard output stream of the pod for this call; defaults to true	false	boolean
QueryParameter	stderr	redirect the standard error stream of the pod for this call; defaults to true	false	boolean
QueryParameter	tty	allocate a terminal for this exec call; defaults to false	false	boolean
QueryParameter	container	the container in which to execute the command. Defaults to only container if there is only one container in the pod.	false	string
QueryParameter	command	the command to execute; argv array; not executed within a shell	false	ref
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.49.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
default	success	string

3.2.49.3. Consumes
Copy link

3.2.49.4. Produces
Copy link

3.2.49.5. Tags
Copy link

apiv1

3.2.50. read log of the specified Pod
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.50.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	container	the container for which to stream logs; defaults to only container if there is one container in the pod	false	string
QueryParameter	follow	follow the log stream of the pod; defaults to false	false	boolean
QueryParameter	previous	return previous terminated container logs; defaults to false	false	boolean
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.50.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.8, “v1.Pod”

3.2.50.3. Consumes
Copy link

3.2.50.4. Produces
Copy link

application/json

3.2.50.5. Tags
Copy link

apiv1

3.2.51. connect GET requests to portforward of Pod
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.51.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema	Default
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.51.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
default	success	string

3.2.51.3. Consumes
Copy link

3.2.51.4. Produces
Copy link

3.2.51.5. Tags
Copy link

apiv1

3.2.52. connect POST requests to portforward of Pod
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.52.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema	Default
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.52.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
default	success	string

3.2.52.3. Consumes
Copy link

3.2.52.4. Produces
Copy link

3.2.52.5. Tags
Copy link

apiv1

3.2.53. connect GET requests to proxy of Pod
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.53.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	path	URL path to use in proxy request to pod	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.53.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
default	success	string

3.2.53.3. Consumes
Copy link

3.2.53.4. Produces
Copy link

3.2.53.5. Tags
Copy link

apiv1

3.2.54. connect PUT requests to proxy of Pod
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.54.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	path	URL path to use in proxy request to pod	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.54.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
default	success	string

3.2.54.3. Consumes
Copy link

3.2.54.4. Produces
Copy link

3.2.54.5. Tags
Copy link

apiv1

3.2.55. connect DELETE requests to proxy of Pod
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.55.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	path	URL path to use in proxy request to pod	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.55.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
default	success	string

3.2.55.3. Consumes
Copy link

3.2.55.4. Produces
Copy link

3.2.55.5. Tags
Copy link

apiv1

3.2.56. connect POST requests to proxy of Pod
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.56.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	path	URL path to use in proxy request to pod	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.56.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
default	success	string

3.2.56.3. Consumes
Copy link

3.2.56.4. Produces
Copy link

3.2.56.5. Tags
Copy link

apiv1

3.2.57. connect GET requests to proxy of Pod
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.57.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	path	URL path to use in proxy request to pod	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string
PathParameter	path:*	path to the resource	true	string

3.2.57.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
default	success	string

3.2.57.3. Consumes
Copy link

3.2.57.4. Produces
Copy link

3.2.57.5. Tags
Copy link

apiv1

3.2.58. connect PUT requests to proxy of Pod
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.58.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	path	URL path to use in proxy request to pod	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string
PathParameter	path:*	path to the resource	true	string

3.2.58.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
default	success	string

3.2.58.3. Consumes
Copy link

3.2.58.4. Produces
Copy link

3.2.58.5. Tags
Copy link

apiv1

3.2.59. connect DELETE requests to proxy of Pod
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.59.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	path	URL path to use in proxy request to pod	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string
PathParameter	path:*	path to the resource	true	string

3.2.59.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
default	success	string

3.2.59.3. Consumes
Copy link

3.2.59.4. Produces
Copy link

3.2.59.5. Tags
Copy link

apiv1

3.2.60. connect POST requests to proxy of Pod
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.60.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	path	URL path to use in proxy request to pod	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string
PathParameter	path:*	path to the resource	true	string

3.2.60.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
default	success	string

3.2.60.3. Consumes
Copy link

3.2.60.4. Produces
Copy link

3.2.60.5. Tags
Copy link

apiv1

3.2.61. replace status of the specified Pod
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.61.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.8, “v1.Pod”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.61.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.8, “v1.Pod”

3.2.61.3. Consumes
Copy link

3.2.61.4. Produces
Copy link

application/json

3.2.61.5. Tags
Copy link

apiv1

3.2.62. list or watch objects of kind PodTemplate
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.62.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.62.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.110, “v1.PodTemplateList”

3.2.62.3. Consumes
Copy link

3.2.62.4. Produces
Copy link

application/json

3.2.62.5. Tags
Copy link

apiv1

3.2.63. create a PodTemplate
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.63.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.68, “v1.PodTemplate”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.63.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.68, “v1.PodTemplate”

3.2.63.3. Consumes
Copy link

3.2.63.4. Produces
Copy link

application/json

3.2.63.5. Tags
Copy link

apiv1

3.2.64. read the specified PodTemplate
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.64.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the PodTemplate	true	string

3.2.64.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.68, “v1.PodTemplate”

3.2.64.3. Consumes
Copy link

3.2.64.4. Produces
Copy link

application/json

3.2.64.5. Tags
Copy link

apiv1

3.2.65. replace the specified PodTemplate
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.65.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.68, “v1.PodTemplate”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the PodTemplate	true	string

3.2.65.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.68, “v1.PodTemplate”

3.2.65.3. Consumes
Copy link

3.2.65.4. Produces
Copy link

application/json

3.2.65.5. Tags
Copy link

apiv1

3.2.66. delete a PodTemplate
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.66.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.23, “v1.DeleteOptions”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the PodTemplate	true	string

3.2.66.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.132, “v1.Status”

3.2.66.3. Consumes
Copy link

3.2.66.4. Produces
Copy link

application/json

3.2.66.5. Tags
Copy link

apiv1

3.2.67. partially update the specified PodTemplate
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.67.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.98, “api.Patch”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the PodTemplate	true	string

3.2.67.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.68, “v1.PodTemplate”

3.2.67.3. Consumes
Copy link

application/json-patch+json
application/merge-patch+json
application/strategic-merge-patch+json

3.2.67.4. Produces
Copy link

application/json

3.2.67.5. Tags
Copy link

apiv1

3.2.68. list or watch objects of kind ReplicationController
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.68.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.68.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.6, “v1.ReplicationControllerList”

3.2.68.3. Consumes
Copy link

3.2.68.4. Produces
Copy link

application/json

3.2.68.5. Tags
Copy link

apiv1

3.2.69. create a ReplicationController
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.69.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.59, “v1.ReplicationController”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.69.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.59, “v1.ReplicationController”

3.2.69.3. Consumes
Copy link

3.2.69.4. Produces
Copy link

application/json

3.2.69.5. Tags
Copy link

apiv1

3.2.70. read the specified ReplicationController
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.70.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the ReplicationController	true	string

3.2.70.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.59, “v1.ReplicationController”

3.2.70.3. Consumes
Copy link

3.2.70.4. Produces
Copy link

application/json

3.2.70.5. Tags
Copy link

apiv1

3.2.71. replace the specified ReplicationController
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.71.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.59, “v1.ReplicationController”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the ReplicationController	true	string

3.2.71.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.59, “v1.ReplicationController”

3.2.71.3. Consumes
Copy link

3.2.71.4. Produces
Copy link

application/json

3.2.71.5. Tags
Copy link

apiv1

3.2.72. delete a ReplicationController
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.72.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.23, “v1.DeleteOptions”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the ReplicationController	true	string

3.2.72.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.132, “v1.Status”

3.2.72.3. Consumes
Copy link

3.2.72.4. Produces
Copy link

application/json

3.2.72.5. Tags
Copy link

apiv1

3.2.73. partially update the specified ReplicationController
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.73.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.98, “api.Patch”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the ReplicationController	true	string

3.2.73.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.59, “v1.ReplicationController”

3.2.73.3. Consumes
Copy link

application/json-patch+json
application/merge-patch+json
application/strategic-merge-patch+json

3.2.73.4. Produces
Copy link

application/json

3.2.73.5. Tags
Copy link

apiv1

3.2.74. list or watch objects of kind ResourceQuota
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.74.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.74.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.74, “v1.ResourceQuotaList”

3.2.74.3. Consumes
Copy link

3.2.74.4. Produces
Copy link

application/json

3.2.74.5. Tags
Copy link

apiv1

3.2.75. create a ResourceQuota
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.75.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.106, “v1.ResourceQuota”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.75.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.106, “v1.ResourceQuota”

3.2.75.3. Consumes
Copy link

3.2.75.4. Produces
Copy link

application/json

3.2.75.5. Tags
Copy link

apiv1

3.2.76. read the specified ResourceQuota
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.76.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the ResourceQuota	true	string

3.2.76.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.106, “v1.ResourceQuota”

3.2.76.3. Consumes
Copy link

3.2.76.4. Produces
Copy link

application/json

3.2.76.5. Tags
Copy link

apiv1

3.2.77. replace the specified ResourceQuota
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.77.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.106, “v1.ResourceQuota”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the ResourceQuota	true	string

3.2.77.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.106, “v1.ResourceQuota”

3.2.77.3. Consumes
Copy link

3.2.77.4. Produces
Copy link

application/json

3.2.77.5. Tags
Copy link

apiv1

3.2.78. delete a ResourceQuota
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.78.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.23, “v1.DeleteOptions”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the ResourceQuota	true	string

3.2.78.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.132, “v1.Status”

3.2.78.3. Consumes
Copy link

3.2.78.4. Produces
Copy link

application/json

3.2.78.5. Tags
Copy link

apiv1

3.2.79. partially update the specified ResourceQuota
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.79.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.98, “api.Patch”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the ResourceQuota	true	string

3.2.79.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.106, “v1.ResourceQuota”

3.2.79.3. Consumes
Copy link

application/json-patch+json
application/merge-patch+json
application/strategic-merge-patch+json

3.2.79.4. Produces
Copy link

application/json

3.2.79.5. Tags
Copy link

apiv1

3.2.80. replace status of the specified ResourceQuota
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.80.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.106, “v1.ResourceQuota”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the ResourceQuota	true	string

3.2.80.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.106, “v1.ResourceQuota”

3.2.80.3. Consumes
Copy link

3.2.80.4. Produces
Copy link

application/json

3.2.80.5. Tags
Copy link

apiv1

3.2.81. list or watch objects of kind Secret
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.81.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.81.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.16, “v1.SecretList”

3.2.81.3. Consumes
Copy link

3.2.81.4. Produces
Copy link

application/json

3.2.81.5. Tags
Copy link

apiv1

3.2.82. create a Secret
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.82.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.87, “v1.Secret”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.82.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.87, “v1.Secret”

3.2.82.3. Consumes
Copy link

3.2.82.4. Produces
Copy link

application/json

3.2.82.5. Tags
Copy link

apiv1

3.2.83. read the specified Secret
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.83.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Secret	true	string

3.2.83.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.87, “v1.Secret”

3.2.83.3. Consumes
Copy link

3.2.83.4. Produces
Copy link

application/json

3.2.83.5. Tags
Copy link

apiv1

3.2.84. replace the specified Secret
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.84.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.87, “v1.Secret”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Secret	true	string

3.2.84.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.87, “v1.Secret”

3.2.84.3. Consumes
Copy link

3.2.84.4. Produces
Copy link

application/json

3.2.84.5. Tags
Copy link

apiv1

3.2.85. delete a Secret
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.85.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.23, “v1.DeleteOptions”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Secret	true	string

3.2.85.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.132, “v1.Status”

3.2.85.3. Consumes
Copy link

3.2.85.4. Produces
Copy link

application/json

3.2.85.5. Tags
Copy link

apiv1

3.2.86. partially update the specified Secret
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.86.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.98, “api.Patch”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Secret	true	string

3.2.86.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.87, “v1.Secret”

3.2.86.3. Consumes
Copy link

application/json-patch+json
application/merge-patch+json
application/strategic-merge-patch+json

3.2.86.4. Produces
Copy link

application/json

3.2.86.5. Tags
Copy link

apiv1

3.2.87. list or watch objects of kind ServiceAccount
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.87.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.87.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.75, “v1.ServiceAccountList”

3.2.87.3. Consumes
Copy link

3.2.87.4. Produces
Copy link

application/json

3.2.87.5. Tags
Copy link

apiv1

3.2.88. create a ServiceAccount
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.88.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.67, “v1.ServiceAccount”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.88.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.67, “v1.ServiceAccount”

3.2.88.3. Consumes
Copy link

3.2.88.4. Produces
Copy link

application/json

3.2.88.5. Tags
Copy link

apiv1

3.2.89. read the specified ServiceAccount
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.89.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the ServiceAccount	true	string

3.2.89.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.67, “v1.ServiceAccount”

3.2.89.3. Consumes
Copy link

3.2.89.4. Produces
Copy link

application/json

3.2.89.5. Tags
Copy link

apiv1

3.2.90. replace the specified ServiceAccount
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.90.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.67, “v1.ServiceAccount”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the ServiceAccount	true	string

3.2.90.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.67, “v1.ServiceAccount”

3.2.90.3. Consumes
Copy link

3.2.90.4. Produces
Copy link

application/json

3.2.90.5. Tags
Copy link

apiv1

3.2.91. delete a ServiceAccount
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.91.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.23, “v1.DeleteOptions”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the ServiceAccount	true	string

3.2.91.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.132, “v1.Status”

3.2.91.3. Consumes
Copy link

3.2.91.4. Produces
Copy link

application/json

3.2.91.5. Tags
Copy link

apiv1

3.2.92. partially update the specified ServiceAccount
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.92.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.98, “api.Patch”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the ServiceAccount	true	string

3.2.92.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.67, “v1.ServiceAccount”

3.2.92.3. Consumes
Copy link

application/json-patch+json
application/merge-patch+json
application/strategic-merge-patch+json

3.2.92.4. Produces
Copy link

application/json

3.2.92.5. Tags
Copy link

apiv1

3.2.93. list or watch objects of kind Service
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.93.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.93.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.34, “v1.ServiceList”

3.2.93.3. Consumes
Copy link

3.2.93.4. Produces
Copy link

application/json

3.2.93.5. Tags
Copy link

apiv1

3.2.94. create a Service
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.94.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.93, “v1.Service”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.94.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.93, “v1.Service”

3.2.94.3. Consumes
Copy link

3.2.94.4. Produces
Copy link

application/json

3.2.94.5. Tags
Copy link

apiv1

3.2.95. read the specified Service
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.95.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string

3.2.95.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.93, “v1.Service”

3.2.95.3. Consumes
Copy link

3.2.95.4. Produces
Copy link

application/json

3.2.95.5. Tags
Copy link

apiv1

3.2.96. replace the specified Service
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.96.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.93, “v1.Service”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string

3.2.96.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.93, “v1.Service”

3.2.96.3. Consumes
Copy link

3.2.96.4. Produces
Copy link

application/json

3.2.96.5. Tags
Copy link

apiv1

3.2.97. delete a Service
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.97.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string

3.2.97.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.132, “v1.Status”

3.2.97.3. Consumes
Copy link

3.2.97.4. Produces
Copy link

application/json

3.2.97.5. Tags
Copy link

apiv1

3.2.98. partially update the specified Service
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.98.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.98, “api.Patch”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string

3.2.98.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.93, “v1.Service”

3.2.98.3. Consumes
Copy link

application/json-patch+json
application/merge-patch+json
application/strategic-merge-patch+json

3.2.98.4. Produces
Copy link

application/json

3.2.98.5. Tags
Copy link

apiv1

3.2.99. read the specified Namespace
Copy link

GET /api/v1/namespaces/{name}

GET /api/v1/namespaces/{name}

Copy to Clipboard

Toggle word wrap

3.2.99.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
PathParameter	name	name of the Namespace	true	string

3.2.99.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.51, “v1.Namespace”

3.2.99.3. Consumes
Copy link

3.2.99.4. Produces
Copy link

application/json

3.2.99.5. Tags
Copy link

apiv1

3.2.100. replace the specified Namespace
Copy link

PUT /api/v1/namespaces/{name}

PUT /api/v1/namespaces/{name}

Copy to Clipboard

Toggle word wrap

3.2.100.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.51, “v1.Namespace”
PathParameter	name	name of the Namespace	true	string

3.2.100.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.51, “v1.Namespace”

3.2.100.3. Consumes
Copy link

3.2.100.4. Produces
Copy link

application/json

3.2.100.5. Tags
Copy link

apiv1

3.2.101. delete a Namespace
Copy link

DELETE /api/v1/namespaces/{name}

DELETE /api/v1/namespaces/{name}

Copy to Clipboard

Toggle word wrap

3.2.101.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.23, “v1.DeleteOptions”
PathParameter	name	name of the Namespace	true	string

3.2.101.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.132, “v1.Status”

3.2.101.3. Consumes
Copy link

3.2.101.4. Produces
Copy link

application/json

3.2.101.5. Tags
Copy link

apiv1

3.2.102. partially update the specified Namespace
Copy link

PATCH /api/v1/namespaces/{name}

PATCH /api/v1/namespaces/{name}

Copy to Clipboard

Toggle word wrap

3.2.102.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.98, “api.Patch”
PathParameter	name	name of the Namespace	true	string

3.2.102.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.51, “v1.Namespace”

3.2.102.3. Consumes
Copy link

application/json-patch+json
application/merge-patch+json
application/strategic-merge-patch+json

3.2.102.4. Produces
Copy link

application/json

3.2.102.5. Tags
Copy link

apiv1

3.2.103. replace finalize of the specified Namespace
Copy link

PUT /api/v1/namespaces/{name}/finalize

PUT /api/v1/namespaces/{name}/finalize

Copy to Clipboard

Toggle word wrap

3.2.103.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.51, “v1.Namespace”
PathParameter	name	name of the Namespace	true	string

3.2.103.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.51, “v1.Namespace”

3.2.103.3. Consumes
Copy link

3.2.103.4. Produces
Copy link

application/json

3.2.103.5. Tags
Copy link

apiv1

3.2.104. replace status of the specified Namespace
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.104.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.51, “v1.Namespace”
PathParameter	name	name of the Namespace	true	string

3.2.104.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.51, “v1.Namespace”

3.2.104.3. Consumes
Copy link

3.2.104.4. Produces
Copy link

application/json

3.2.104.5. Tags
Copy link

apiv1

3.2.105. list or watch objects of kind Node
Copy link

GET /api/v1/nodes

GET /api/v1/nodes

Copy to Clipboard

Toggle word wrap

3.2.105.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string

3.2.105.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.54, “v1.NodeList”

3.2.105.3. Consumes
Copy link

3.2.105.4. Produces
Copy link

application/json

3.2.105.5. Tags
Copy link

apiv1

3.2.106. create a Node
Copy link

POST /api/v1/nodes

POST /api/v1/nodes

Copy to Clipboard

Toggle word wrap

3.2.106.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.104, “v1.Node”

3.2.106.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.104, “v1.Node”

3.2.106.3. Consumes
Copy link

3.2.106.4. Produces
Copy link

application/json

3.2.106.5. Tags
Copy link

apiv1

3.2.107. read the specified Node
Copy link

GET /api/v1/nodes/{name}

GET /api/v1/nodes/{name}

Copy to Clipboard

Toggle word wrap

3.2.107.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
PathParameter	name	name of the Node	true	string

3.2.107.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.104, “v1.Node”

3.2.107.3. Consumes
Copy link

3.2.107.4. Produces
Copy link

application/json

3.2.107.5. Tags
Copy link

apiv1

3.2.108. replace the specified Node
Copy link

PUT /api/v1/nodes/{name}

PUT /api/v1/nodes/{name}

Copy to Clipboard

Toggle word wrap

3.2.108.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.104, “v1.Node”
PathParameter	name	name of the Node	true	string

3.2.108.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.104, “v1.Node”

3.2.108.3. Consumes
Copy link

3.2.108.4. Produces
Copy link

application/json

3.2.108.5. Tags
Copy link

apiv1

3.2.109. delete a Node
Copy link

DELETE /api/v1/nodes/{name}

DELETE /api/v1/nodes/{name}

Copy to Clipboard

Toggle word wrap

3.2.109.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.23, “v1.DeleteOptions”
PathParameter	name	name of the Node	true	string

3.2.109.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.132, “v1.Status”

3.2.109.3. Consumes
Copy link

3.2.109.4. Produces
Copy link

application/json

3.2.109.5. Tags
Copy link

apiv1

3.2.110. partially update the specified Node
Copy link

PATCH /api/v1/nodes/{name}

PATCH /api/v1/nodes/{name}

Copy to Clipboard

Toggle word wrap

3.2.110.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.98, “api.Patch”
PathParameter	name	name of the Node	true	string

3.2.110.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.104, “v1.Node”

3.2.110.3. Consumes
Copy link

application/json-patch+json
application/merge-patch+json
application/strategic-merge-patch+json

3.2.110.4. Produces
Copy link

application/json

3.2.110.5. Tags
Copy link

apiv1

3.2.111. replace status of the specified Node
Copy link

PUT /api/v1/nodes/{name}/status

PUT /api/v1/nodes/{name}/status

Copy to Clipboard

Toggle word wrap

3.2.111.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.104, “v1.Node”
PathParameter	name	name of the Node	true	string

3.2.111.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.104, “v1.Node”

3.2.111.3. Consumes
Copy link

3.2.111.4. Produces
Copy link

application/json

3.2.111.5. Tags
Copy link

apiv1

3.2.112. list or watch objects of kind PersistentVolumeClaim
Copy link

GET /api/v1/persistentvolumeclaims

GET /api/v1/persistentvolumeclaims

Copy to Clipboard

Toggle word wrap

3.2.112.1. Description
Copy link

3.2.112.2. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string

3.2.112.3. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.81, “v1.PersistentVolumeClaimList”

3.2.112.4. Consumes
Copy link

3.2.112.5. Produces
Copy link

application/json

3.2.112.6. Tags
Copy link

apiv1

3.2.113. create a PersistentVolumeClaim
Copy link

POST /api/v1/persistentvolumeclaims

POST /api/v1/persistentvolumeclaims

Copy to Clipboard

Toggle word wrap

3.2.113.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.24, “v1.PersistentVolumeClaim”

3.2.113.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.24, “v1.PersistentVolumeClaim”

3.2.113.3. Consumes
Copy link

3.2.113.4. Produces
Copy link

application/json

3.2.113.5. Tags
Copy link

apiv1

3.2.114. list or watch objects of kind PersistentVolume
Copy link

GET /api/v1/persistentvolumes

GET /api/v1/persistentvolumes

Copy to Clipboard

Toggle word wrap

3.2.114.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string

3.2.114.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.35, “v1.PersistentVolumeList”

3.2.114.3. Consumes
Copy link

3.2.114.4. Produces
Copy link

application/json

3.2.114.5. Tags
Copy link

apiv1

3.2.115. create a PersistentVolume
Copy link

POST /api/v1/persistentvolumes

POST /api/v1/persistentvolumes

Copy to Clipboard

Toggle word wrap

3.2.115.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.1, “v1.PersistentVolume”

3.2.115.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.1, “v1.PersistentVolume”

3.2.115.3. Consumes
Copy link

3.2.115.4. Produces
Copy link

application/json

3.2.115.5. Tags
Copy link

apiv1

3.2.116. read the specified PersistentVolume
Copy link

GET /api/v1/persistentvolumes/{name}

GET /api/v1/persistentvolumes/{name}

Copy to Clipboard

Toggle word wrap

3.2.116.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
PathParameter	name	name of the PersistentVolume	true	string

3.2.116.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.1, “v1.PersistentVolume”

3.2.116.3. Consumes
Copy link

3.2.116.4. Produces
Copy link

application/json

3.2.116.5. Tags
Copy link

apiv1

3.2.117. replace the specified PersistentVolume
Copy link

PUT /api/v1/persistentvolumes/{name}

PUT /api/v1/persistentvolumes/{name}

Copy to Clipboard

Toggle word wrap

3.2.117.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.1, “v1.PersistentVolume”
PathParameter	name	name of the PersistentVolume	true	string

3.2.117.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.1, “v1.PersistentVolume”

3.2.117.3. Consumes
Copy link

3.2.117.4. Produces
Copy link

application/json

3.2.117.5. Tags
Copy link

apiv1

3.2.118. delete a PersistentVolume
Copy link

DELETE /api/v1/persistentvolumes/{name}

DELETE /api/v1/persistentvolumes/{name}

Copy to Clipboard

Toggle word wrap

3.2.118.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.23, “v1.DeleteOptions”
PathParameter	name	name of the PersistentVolume	true	string

3.2.118.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.132, “v1.Status”

3.2.118.3. Consumes
Copy link

3.2.118.4. Produces
Copy link

application/json

3.2.118.5. Tags
Copy link

apiv1

3.2.119. partially update the specified PersistentVolume
Copy link

PATCH /api/v1/persistentvolumes/{name}

PATCH /api/v1/persistentvolumes/{name}

Copy to Clipboard

Toggle word wrap

3.2.119.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.98, “api.Patch”
PathParameter	name	name of the PersistentVolume	true	string

3.2.119.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.1, “v1.PersistentVolume”

3.2.119.3. Consumes
Copy link

application/json-patch+json
application/merge-patch+json
application/strategic-merge-patch+json

3.2.119.4. Produces
Copy link

application/json

3.2.119.5. Tags
Copy link

apiv1

3.2.120. replace status of the specified PersistentVolume
Copy link

PUT /api/v1/persistentvolumes/{name}/status

PUT /api/v1/persistentvolumes/{name}/status

Copy to Clipboard

Toggle word wrap

3.2.120.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.1, “v1.PersistentVolume”
PathParameter	name	name of the PersistentVolume	true	string

3.2.120.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.1, “v1.PersistentVolume”

3.2.120.3. Consumes
Copy link

3.2.120.4. Produces
Copy link

application/json

3.2.120.5. Tags
Copy link

apiv1

3.2.121. list or watch objects of kind Pod
Copy link

GET /api/v1/pods

GET /api/v1/pods

Copy to Clipboard

Toggle word wrap

3.2.121.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string

3.2.121.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.69, “v1.PodList”

3.2.121.3. Consumes
Copy link

3.2.121.4. Produces
Copy link

application/json

3.2.121.5. Tags
Copy link

apiv1

3.2.122. create a Pod
Copy link

POST /api/v1/pods

POST /api/v1/pods

Copy to Clipboard

Toggle word wrap

3.2.122.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.8, “v1.Pod”

3.2.122.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.8, “v1.Pod”

3.2.122.3. Consumes
Copy link

3.2.122.4. Produces
Copy link

application/json

3.2.122.5. Tags
Copy link

apiv1

3.2.123. list or watch objects of kind PodTemplate
Copy link

GET /api/v1/podtemplates

GET /api/v1/podtemplates

Copy to Clipboard

Toggle word wrap

3.2.123.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string

3.2.123.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.110, “v1.PodTemplateList”

3.2.123.3. Consumes
Copy link

3.2.123.4. Produces
Copy link

application/json

3.2.123.5. Tags
Copy link

apiv1

3.2.124. create a PodTemplate
Copy link

POST /api/v1/podtemplates

POST /api/v1/podtemplates

Copy to Clipboard

Toggle word wrap

3.2.124.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.68, “v1.PodTemplate”

3.2.124.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.68, “v1.PodTemplate”

3.2.124.3. Consumes
Copy link

3.2.124.4. Produces
Copy link

application/json

3.2.124.5. Tags
Copy link

apiv1

3.2.125. proxy GET requests to Pod
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.125.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema	Default
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.125.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
default	success	string

3.2.125.3. Consumes
Copy link

3.2.125.4. Produces
Copy link

3.2.125.5. Tags
Copy link

apiv1

3.2.126. proxy PUT requests to Pod
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.126.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema	Default
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.126.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
default	success	string

3.2.126.3. Consumes
Copy link

3.2.126.4. Produces
Copy link

3.2.126.5. Tags
Copy link

apiv1

3.2.127. proxy DELETE requests to Pod
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.127.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema	Default
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.127.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
default	success	string

3.2.127.3. Consumes
Copy link

3.2.127.4. Produces
Copy link

3.2.127.5. Tags
Copy link

apiv1

3.2.128. proxy POST requests to Pod
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.128.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema	Default
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.128.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
default	success	string

3.2.128.3. Consumes
Copy link

3.2.128.4. Produces
Copy link

3.2.128.5. Tags
Copy link

apiv1

3.2.129. proxy GET requests to Pod
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.129.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string
PathParameter	path:*	path to the resource	true	string

3.2.129.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
default	success	string

3.2.129.3. Consumes
Copy link

3.2.129.4. Produces
Copy link

3.2.129.5. Tags
Copy link

apiv1

3.2.130. proxy PUT requests to Pod
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.130.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string
PathParameter	path:*	path to the resource	true	string

3.2.130.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
default	success	string

3.2.130.3. Consumes
Copy link

3.2.130.4. Produces
Copy link

3.2.130.5. Tags
Copy link

apiv1

3.2.131. proxy DELETE requests to Pod
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.131.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string
PathParameter	path:*	path to the resource	true	string

3.2.131.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
default	success	string

3.2.131.3. Consumes
Copy link

3.2.131.4. Produces
Copy link

3.2.131.5. Tags
Copy link

apiv1

3.2.132. proxy POST requests to Pod
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.132.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string
PathParameter	path:*	path to the resource	true	string

3.2.132.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
default	success	string

3.2.132.3. Consumes
Copy link

3.2.132.4. Produces
Copy link

3.2.132.5. Tags
Copy link

apiv1

3.2.133. proxy GET requests to Service
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.133.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema	Default
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string

3.2.133.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
default	success	string

3.2.133.3. Consumes
Copy link

3.2.133.4. Produces
Copy link

3.2.133.5. Tags
Copy link

apiv1

3.2.134. proxy PUT requests to Service
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.134.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema	Default
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string

3.2.134.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
default	success	string

3.2.134.3. Consumes
Copy link

3.2.134.4. Produces
Copy link

3.2.134.5. Tags
Copy link

apiv1

3.2.135. proxy DELETE requests to Service
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.135.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema	Default
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string

3.2.135.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
default	success	string

3.2.135.3. Consumes
Copy link

3.2.135.4. Produces
Copy link

3.2.135.5. Tags
Copy link

apiv1

3.2.136. proxy POST requests to Service
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.136.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema	Default
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string

3.2.136.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
default	success	string

3.2.136.3. Consumes
Copy link

3.2.136.4. Produces
Copy link

3.2.136.5. Tags
Copy link

apiv1

3.2.137. proxy GET requests to Service
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.137.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string
PathParameter	path:*	path to the resource	true	string

3.2.137.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
default	success	string

3.2.137.3. Consumes
Copy link

3.2.137.4. Produces
Copy link

3.2.137.5. Tags
Copy link

apiv1

3.2.138. proxy PUT requests to Service
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.138.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string
PathParameter	path:*	path to the resource	true	string

3.2.138.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
default	success	string

3.2.138.3. Consumes
Copy link

3.2.138.4. Produces
Copy link

3.2.138.5. Tags
Copy link

apiv1

3.2.139. proxy DELETE requests to Service
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.139.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string
PathParameter	path:*	path to the resource	true	string

3.2.139.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
default	success	string

3.2.139.3. Consumes
Copy link

3.2.139.4. Produces
Copy link

3.2.139.5. Tags
Copy link

apiv1

3.2.140. proxy POST requests to Service
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.140.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string
PathParameter	path:*	path to the resource	true	string

3.2.140.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
default	success	string

3.2.140.3. Consumes
Copy link

3.2.140.4. Produces
Copy link

3.2.140.5. Tags
Copy link

apiv1

3.2.141. proxy GET requests to Node
Copy link

GET /api/v1/proxy/nodes/{name}

GET /api/v1/proxy/nodes/{name}

Copy to Clipboard

Toggle word wrap

3.2.141.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema	Default
PathParameter	name	name of the Node	true	string

3.2.141.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
default	success	string

3.2.141.3. Consumes
Copy link

3.2.141.4. Produces
Copy link

3.2.141.5. Tags
Copy link

apiv1

3.2.142. proxy PUT requests to Node
Copy link

PUT /api/v1/proxy/nodes/{name}

PUT /api/v1/proxy/nodes/{name}

Copy to Clipboard

Toggle word wrap

3.2.142.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema	Default
PathParameter	name	name of the Node	true	string

3.2.142.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
default	success	string

3.2.142.3. Consumes
Copy link

3.2.142.4. Produces
Copy link

3.2.142.5. Tags
Copy link

apiv1

3.2.143. proxy DELETE requests to Node
Copy link

DELETE /api/v1/proxy/nodes/{name}

DELETE /api/v1/proxy/nodes/{name}

Copy to Clipboard

Toggle word wrap

3.2.143.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema	Default
PathParameter	name	name of the Node	true	string

3.2.143.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
default	success	string

3.2.143.3. Consumes
Copy link

3.2.143.4. Produces
Copy link

3.2.143.5. Tags
Copy link

apiv1

3.2.144. proxy POST requests to Node
Copy link

POST /api/v1/proxy/nodes/{name}

POST /api/v1/proxy/nodes/{name}

Copy to Clipboard

Toggle word wrap

3.2.144.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema	Default
PathParameter	name	name of the Node	true	string

3.2.144.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
default	success	string

3.2.144.3. Consumes
Copy link

3.2.144.4. Produces
Copy link

3.2.144.5. Tags
Copy link

apiv1

3.2.145. proxy GET requests to Node
Copy link

GET /api/v1/proxy/nodes/{name}/{path:*}

GET /api/v1/proxy/nodes/{name}/{path:*}

Copy to Clipboard

Toggle word wrap

3.2.145.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema	Default
PathParameter	name	name of the Node	true	string
PathParameter	path:*	path to the resource	true	string

3.2.145.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
default	success	string

3.2.145.3. Consumes
Copy link

3.2.145.4. Produces
Copy link

3.2.145.5. Tags
Copy link

apiv1

3.2.146. proxy PUT requests to Node
Copy link

PUT /api/v1/proxy/nodes/{name}/{path:*}

PUT /api/v1/proxy/nodes/{name}/{path:*}

Copy to Clipboard

Toggle word wrap

3.2.146.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema	Default
PathParameter	name	name of the Node	true	string
PathParameter	path:*	path to the resource	true	string

3.2.146.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
default	success	string

3.2.146.3. Consumes
Copy link

3.2.146.4. Produces
Copy link

3.2.146.5. Tags
Copy link

apiv1

3.2.147. proxy DELETE requests to Node
Copy link

DELETE /api/v1/proxy/nodes/{name}/{path:*}

DELETE /api/v1/proxy/nodes/{name}/{path:*}

Copy to Clipboard

Toggle word wrap

3.2.147.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema	Default
PathParameter	name	name of the Node	true	string
PathParameter	path:*	path to the resource	true	string

3.2.147.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
default	success	string

3.2.147.3. Consumes
Copy link

3.2.147.4. Produces
Copy link

3.2.147.5. Tags
Copy link

apiv1

3.2.148. proxy POST requests to Node
Copy link

POST /api/v1/proxy/nodes/{name}/{path:*}

POST /api/v1/proxy/nodes/{name}/{path:*}

Copy to Clipboard

Toggle word wrap

3.2.148.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema	Default
PathParameter	name	name of the Node	true	string
PathParameter	path:*	path to the resource	true	string

3.2.148.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
default	success	string

3.2.148.3. Consumes
Copy link

3.2.148.4. Produces
Copy link

3.2.148.5. Tags
Copy link

apiv1

3.2.149. list or watch objects of kind ReplicationController
Copy link

GET /api/v1/replicationcontrollers

GET /api/v1/replicationcontrollers

Copy to Clipboard

Toggle word wrap

3.2.149.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string

3.2.149.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.6, “v1.ReplicationControllerList”

3.2.149.3. Consumes
Copy link

3.2.149.4. Produces
Copy link

application/json

3.2.149.5. Tags
Copy link

apiv1

3.2.150. create a ReplicationController
Copy link

POST /api/v1/replicationcontrollers

POST /api/v1/replicationcontrollers

Copy to Clipboard

Toggle word wrap

3.2.150.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.59, “v1.ReplicationController”

3.2.150.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.59, “v1.ReplicationController”

3.2.150.3. Consumes
Copy link

3.2.150.4. Produces
Copy link

application/json

3.2.150.5. Tags
Copy link

apiv1

3.2.151. list or watch objects of kind ResourceQuota
Copy link

GET /api/v1/resourcequotas

GET /api/v1/resourcequotas

Copy to Clipboard

Toggle word wrap

3.2.151.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string

3.2.151.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.74, “v1.ResourceQuotaList”

3.2.151.3. Consumes
Copy link

3.2.151.4. Produces
Copy link

application/json

3.2.151.5. Tags
Copy link

apiv1

3.2.152. create a ResourceQuota
Copy link

POST /api/v1/resourcequotas

POST /api/v1/resourcequotas

Copy to Clipboard

Toggle word wrap

3.2.152.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.106, “v1.ResourceQuota”

3.2.152.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.106, “v1.ResourceQuota”

3.2.152.3. Consumes
Copy link

3.2.152.4. Produces
Copy link

application/json

3.2.152.5. Tags
Copy link

apiv1

3.2.153. list or watch objects of kind Secret
Copy link

GET /api/v1/secrets

GET /api/v1/secrets

Copy to Clipboard

Toggle word wrap

3.2.153.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string

3.2.153.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.16, “v1.SecretList”

3.2.153.3. Consumes
Copy link

3.2.153.4. Produces
Copy link

application/json

3.2.153.5. Tags
Copy link

apiv1

3.2.154. create a Secret
Copy link

POST /api/v1/secrets

POST /api/v1/secrets

Copy to Clipboard

Toggle word wrap

3.2.154.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.87, “v1.Secret”

3.2.154.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.87, “v1.Secret”

3.2.154.3. Consumes
Copy link

3.2.154.4. Produces
Copy link

application/json

3.2.154.5. Tags
Copy link

apiv1

3.2.155. list or watch objects of kind SecurityContextConstraints
Copy link

GET /api/v1/securitycontextconstraints

GET /api/v1/securitycontextconstraints

Copy to Clipboard

Toggle word wrap

3.2.155.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string

3.2.155.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.25, “v1.SecurityContextConstraintsList”

3.2.155.3. Consumes
Copy link

3.2.155.4. Produces
Copy link

application/json

3.2.155.5. Tags
Copy link

apiv1

3.2.156. create a SecurityContextConstraints
Copy link

POST /api/v1/securitycontextconstraints

POST /api/v1/securitycontextconstraints

Copy to Clipboard

Toggle word wrap

3.2.156.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.61, “v1.SecurityContextConstraints”

3.2.156.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.61, “v1.SecurityContextConstraints”

3.2.156.3. Consumes
Copy link

3.2.156.4. Produces
Copy link

application/json

3.2.156.5. Tags
Copy link

apiv1

3.2.157. read the specified SecurityContextConstraints
Copy link

GET /api/v1/securitycontextconstraints/{name}

GET /api/v1/securitycontextconstraints/{name}

Copy to Clipboard

Toggle word wrap

3.2.157.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
PathParameter	name	name of the SecurityContextConstraints	true	string

3.2.157.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.61, “v1.SecurityContextConstraints”

3.2.157.3. Consumes
Copy link

3.2.157.4. Produces
Copy link

application/json

3.2.157.5. Tags
Copy link

apiv1

3.2.158. replace the specified SecurityContextConstraints
Copy link

PUT /api/v1/securitycontextconstraints/{name}

PUT /api/v1/securitycontextconstraints/{name}

Copy to Clipboard

Toggle word wrap

3.2.158.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.61, “v1.SecurityContextConstraints”
PathParameter	name	name of the SecurityContextConstraints	true	string

3.2.158.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.61, “v1.SecurityContextConstraints”

3.2.158.3. Consumes
Copy link

3.2.158.4. Produces
Copy link

application/json

3.2.158.5. Tags
Copy link

apiv1

3.2.159. delete a SecurityContextConstraints
Copy link

DELETE /api/v1/securitycontextconstraints/{name}

DELETE /api/v1/securitycontextconstraints/{name}

Copy to Clipboard

Toggle word wrap

3.2.159.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.23, “v1.DeleteOptions”
PathParameter	name	name of the SecurityContextConstraints	true	string

3.2.159.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.132, “v1.Status”

3.2.159.3. Consumes
Copy link

3.2.159.4. Produces
Copy link

application/json

3.2.159.5. Tags
Copy link

apiv1

3.2.160. partially update the specified SecurityContextConstraints
Copy link

PATCH /api/v1/securitycontextconstraints/{name}

PATCH /api/v1/securitycontextconstraints/{name}

Copy to Clipboard

Toggle word wrap

3.2.160.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.98, “api.Patch”
PathParameter	name	name of the SecurityContextConstraints	true	string

3.2.160.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.61, “v1.SecurityContextConstraints”

3.2.160.3. Consumes
Copy link

application/json-patch+json
application/merge-patch+json
application/strategic-merge-patch+json

3.2.160.4. Produces
Copy link

application/json

3.2.160.5. Tags
Copy link

apiv1

3.2.161. list or watch objects of kind ServiceAccount
Copy link

GET /api/v1/serviceaccounts

GET /api/v1/serviceaccounts

Copy to Clipboard

Toggle word wrap

3.2.161.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string

3.2.161.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.75, “v1.ServiceAccountList”

3.2.161.3. Consumes
Copy link

3.2.161.4. Produces
Copy link

application/json

3.2.161.5. Tags
Copy link

apiv1

3.2.162. create a ServiceAccount
Copy link

POST /api/v1/serviceaccounts

POST /api/v1/serviceaccounts

Copy to Clipboard

Toggle word wrap

3.2.162.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.67, “v1.ServiceAccount”

3.2.162.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.67, “v1.ServiceAccount”

3.2.162.3. Consumes
Copy link

3.2.162.4. Produces
Copy link

application/json

3.2.162.5. Tags
Copy link

apiv1

3.2.163. list or watch objects of kind Service
Copy link

GET /api/v1/services

GET /api/v1/services

Copy to Clipboard

Toggle word wrap

3.2.163.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string

3.2.163.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.34, “v1.ServiceList”

3.2.163.3. Consumes
Copy link

3.2.163.4. Produces
Copy link

application/json

3.2.163.5. Tags
Copy link

apiv1

3.2.164. create a Service
Copy link

POST /api/v1/services

POST /api/v1/services

Copy to Clipboard

Toggle word wrap

3.2.164.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.93, “v1.Service”

3.2.164.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 3.3.93, “v1.Service”

3.2.164.3. Consumes
Copy link

3.2.164.4. Produces
Copy link

application/json

3.2.164.5. Tags
Copy link

apiv1

3.2.165. watch individual changes to a list of Endpoints
Copy link

GET /api/v1/watch/endpoints

GET /api/v1/watch/endpoints

Copy to Clipboard

Toggle word wrap

3.2.165.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string

3.2.165.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.165.3. Consumes
Copy link

3.2.165.4. Produces
Copy link

application/json

3.2.165.5. Tags
Copy link

apiv1

3.2.166. watch individual changes to a list of Event
Copy link

GET /api/v1/watch/events

GET /api/v1/watch/events

Copy to Clipboard

Toggle word wrap

3.2.166.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string

3.2.166.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.166.3. Consumes
Copy link

3.2.166.4. Produces
Copy link

application/json

3.2.166.5. Tags
Copy link

apiv1

3.2.167. watch individual changes to a list of LimitRange
Copy link

GET /api/v1/watch/limitranges

GET /api/v1/watch/limitranges

Copy to Clipboard

Toggle word wrap

3.2.167.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string

3.2.167.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.167.3. Consumes
Copy link

3.2.167.4. Produces
Copy link

application/json

3.2.167.5. Tags
Copy link

apiv1

3.2.168. watch individual changes to a list of Namespace
Copy link

GET /api/v1/watch/namespaces

GET /api/v1/watch/namespaces

Copy to Clipboard

Toggle word wrap

3.2.168.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string

3.2.168.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.168.3. Consumes
Copy link

3.2.168.4. Produces
Copy link

application/json

3.2.168.5. Tags
Copy link

apiv1

3.2.169. watch individual changes to a list of Endpoints
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.169.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.169.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.169.3. Consumes
Copy link

3.2.169.4. Produces
Copy link

application/json

3.2.169.5. Tags
Copy link

apiv1

3.2.170. watch changes to an object of kind Endpoints
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.170.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Endpoints	true	string

3.2.170.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.170.3. Consumes
Copy link

3.2.170.4. Produces
Copy link

application/json

3.2.170.5. Tags
Copy link

apiv1

3.2.171. watch individual changes to a list of Event
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.171.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.171.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.171.3. Consumes
Copy link

3.2.171.4. Produces
Copy link

application/json

3.2.171.5. Tags
Copy link

apiv1

3.2.172. watch changes to an object of kind Event
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.172.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Event	true	string

3.2.172.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.172.3. Consumes
Copy link

3.2.172.4. Produces
Copy link

application/json

3.2.172.5. Tags
Copy link

apiv1

3.2.173. watch individual changes to a list of LimitRange
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.173.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.173.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.173.3. Consumes
Copy link

3.2.173.4. Produces
Copy link

application/json

3.2.173.5. Tags
Copy link

apiv1

3.2.174. watch changes to an object of kind LimitRange
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.174.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the LimitRange	true	string

3.2.174.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.174.3. Consumes
Copy link

3.2.174.4. Produces
Copy link

application/json

3.2.174.5. Tags
Copy link

apiv1

3.2.175. watch individual changes to a list of PersistentVolumeClaim
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.175.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.175.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.175.3. Consumes
Copy link

3.2.175.4. Produces
Copy link

application/json

3.2.175.5. Tags
Copy link

apiv1

3.2.176. watch changes to an object of kind PersistentVolumeClaim
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.176.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the PersistentVolumeClaim	true	string

3.2.176.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.176.3. Consumes
Copy link

3.2.176.4. Produces
Copy link

application/json

3.2.176.5. Tags
Copy link

apiv1

3.2.177. watch individual changes to a list of Pod
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.177.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.177.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.177.3. Consumes
Copy link

3.2.177.4. Produces
Copy link

application/json

3.2.177.5. Tags
Copy link

apiv1

3.2.178. watch changes to an object of kind Pod
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.178.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.178.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.178.3. Consumes
Copy link

3.2.178.4. Produces
Copy link

application/json

3.2.178.5. Tags
Copy link

apiv1

3.2.179. watch individual changes to a list of PodTemplate
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.179.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.179.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.179.3. Consumes
Copy link

3.2.179.4. Produces
Copy link

application/json

3.2.179.5. Tags
Copy link

apiv1

3.2.180. watch changes to an object of kind PodTemplate
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.180.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the PodTemplate	true	string

3.2.180.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.180.3. Consumes
Copy link

3.2.180.4. Produces
Copy link

application/json

3.2.180.5. Tags
Copy link

apiv1

3.2.181. watch individual changes to a list of ReplicationController
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.181.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.181.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.181.3. Consumes
Copy link

3.2.181.4. Produces
Copy link

application/json

3.2.181.5. Tags
Copy link

apiv1

3.2.182. watch changes to an object of kind ReplicationController
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.182.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the ReplicationController	true	string

3.2.182.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.182.3. Consumes
Copy link

3.2.182.4. Produces
Copy link

application/json

3.2.182.5. Tags
Copy link

apiv1

3.2.183. watch individual changes to a list of ResourceQuota
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.183.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.183.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.183.3. Consumes
Copy link

3.2.183.4. Produces
Copy link

application/json

3.2.183.5. Tags
Copy link

apiv1

3.2.184. watch changes to an object of kind ResourceQuota
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.184.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the ResourceQuota	true	string

3.2.184.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.184.3. Consumes
Copy link

3.2.184.4. Produces
Copy link

application/json

3.2.184.5. Tags
Copy link

apiv1

3.2.185. watch individual changes to a list of Secret
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.185.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.185.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.185.3. Consumes
Copy link

3.2.185.4. Produces
Copy link

application/json

3.2.185.5. Tags
Copy link

apiv1

3.2.186. watch changes to an object of kind Secret
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.186.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Secret	true	string

3.2.186.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.186.3. Consumes
Copy link

3.2.186.4. Produces
Copy link

application/json

3.2.186.5. Tags
Copy link

apiv1

3.2.187. watch individual changes to a list of ServiceAccount
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.187.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.187.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.187.3. Consumes
Copy link

3.2.187.4. Produces
Copy link

application/json

3.2.187.5. Tags
Copy link

apiv1

3.2.188. watch changes to an object of kind ServiceAccount
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.188.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the ServiceAccount	true	string

3.2.188.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.188.3. Consumes
Copy link

3.2.188.4. Produces
Copy link

application/json

3.2.188.5. Tags
Copy link

apiv1

3.2.189. watch individual changes to a list of Service
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.189.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.189.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.189.3. Consumes
Copy link

3.2.189.4. Produces
Copy link

application/json

3.2.189.5. Tags
Copy link

apiv1

3.2.190. watch changes to an object of kind Service
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.190.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string

3.2.190.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.190.3. Consumes
Copy link

3.2.190.4. Produces
Copy link

application/json

3.2.190.5. Tags
Copy link

apiv1

3.2.191. watch changes to an object of kind Namespace
Copy link

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

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

Copy to Clipboard

Toggle word wrap

3.2.191.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string
PathParameter	name	name of the Namespace	true	string

3.2.191.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.191.3. Consumes
Copy link

3.2.191.4. Produces
Copy link

application/json

3.2.191.5. Tags
Copy link

apiv1

3.2.192. watch individual changes to a list of Node
Copy link

GET /api/v1/watch/nodes

GET /api/v1/watch/nodes

Copy to Clipboard

Toggle word wrap

3.2.192.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string

3.2.192.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.192.3. Consumes
Copy link

3.2.192.4. Produces
Copy link

application/json

3.2.192.5. Tags
Copy link

apiv1

3.2.193. watch changes to an object of kind Node
Copy link

GET /api/v1/watch/nodes/{name}

GET /api/v1/watch/nodes/{name}

Copy to Clipboard

Toggle word wrap

3.2.193.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string
PathParameter	name	name of the Node	true	string

3.2.193.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.193.3. Consumes
Copy link

3.2.193.4. Produces
Copy link

application/json

3.2.193.5. Tags
Copy link

apiv1

3.2.194. watch individual changes to a list of PersistentVolumeClaim
Copy link

GET /api/v1/watch/persistentvolumeclaims

GET /api/v1/watch/persistentvolumeclaims

Copy to Clipboard

Toggle word wrap

3.2.194.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string

3.2.194.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.194.3. Consumes
Copy link

3.2.194.4. Produces
Copy link

application/json

3.2.194.5. Tags
Copy link

apiv1

3.2.195. watch individual changes to a list of PersistentVolume
Copy link

GET /api/v1/watch/persistentvolumes

GET /api/v1/watch/persistentvolumes

Copy to Clipboard

Toggle word wrap

3.2.195.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string

3.2.195.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.195.3. Consumes
Copy link

3.2.195.4. Produces
Copy link

application/json

3.2.195.5. Tags
Copy link

apiv1

3.2.196. watch changes to an object of kind PersistentVolume
Copy link

GET /api/v1/watch/persistentvolumes/{name}

GET /api/v1/watch/persistentvolumes/{name}

Copy to Clipboard

Toggle word wrap

3.2.196.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string
PathParameter	name	name of the PersistentVolume	true	string

3.2.196.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.196.3. Consumes
Copy link

3.2.196.4. Produces
Copy link

application/json

3.2.196.5. Tags
Copy link

apiv1

3.2.197. watch individual changes to a list of Pod
Copy link

GET /api/v1/watch/pods

GET /api/v1/watch/pods

Copy to Clipboard

Toggle word wrap

3.2.197.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string

3.2.197.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.197.3. Consumes
Copy link

3.2.197.4. Produces
Copy link

application/json

3.2.197.5. Tags
Copy link

apiv1

3.2.198. watch individual changes to a list of PodTemplate
Copy link

GET /api/v1/watch/podtemplates

GET /api/v1/watch/podtemplates

Copy to Clipboard

Toggle word wrap

3.2.198.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string

3.2.198.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.198.3. Consumes
Copy link

3.2.198.4. Produces
Copy link

application/json

3.2.198.5. Tags
Copy link

apiv1

3.2.199. watch individual changes to a list of ReplicationController
Copy link

GET /api/v1/watch/replicationcontrollers

GET /api/v1/watch/replicationcontrollers

Copy to Clipboard

Toggle word wrap

3.2.199.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string

3.2.199.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.199.3. Consumes
Copy link

3.2.199.4. Produces
Copy link

application/json

3.2.199.5. Tags
Copy link

apiv1

3.2.200. watch individual changes to a list of ResourceQuota
Copy link

GET /api/v1/watch/resourcequotas

GET /api/v1/watch/resourcequotas

Copy to Clipboard

Toggle word wrap

3.2.200.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string

3.2.200.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.200.3. Consumes
Copy link

3.2.200.4. Produces
Copy link

application/json

3.2.200.5. Tags
Copy link

apiv1

3.2.201. watch individual changes to a list of Secret
Copy link

GET /api/v1/watch/secrets

GET /api/v1/watch/secrets

Copy to Clipboard

Toggle word wrap

3.2.201.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string

3.2.201.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.201.3. Consumes
Copy link

3.2.201.4. Produces
Copy link

application/json

3.2.201.5. Tags
Copy link

apiv1

3.2.202. watch individual changes to a list of SecurityContextConstraints
Copy link

GET /api/v1/watch/securitycontextconstraints

GET /api/v1/watch/securitycontextconstraints

Copy to Clipboard

Toggle word wrap

3.2.202.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string

3.2.202.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.202.3. Consumes
Copy link

3.2.202.4. Produces
Copy link

application/json

3.2.202.5. Tags
Copy link

apiv1

3.2.203. watch changes to an object of kind SecurityContextConstraints
Copy link

GET /api/v1/watch/securitycontextconstraints/{name}

GET /api/v1/watch/securitycontextconstraints/{name}

Copy to Clipboard

Toggle word wrap

3.2.203.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string
PathParameter	name	name of the SecurityContextConstraints	true	string

3.2.203.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.203.3. Consumes
Copy link

3.2.203.4. Produces
Copy link

application/json

3.2.203.5. Tags
Copy link

apiv1

3.2.204. watch individual changes to a list of ServiceAccount
Copy link

GET /api/v1/watch/serviceaccounts

GET /api/v1/watch/serviceaccounts

Copy to Clipboard

Toggle word wrap

3.2.204.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string

3.2.204.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.204.3. Consumes
Copy link

3.2.204.4. Produces
Copy link

application/json

3.2.204.5. Tags
Copy link

apiv1

3.2.205. watch individual changes to a list of Service
Copy link

GET /api/v1/watch/services

GET /api/v1/watch/services

Copy to Clipboard

Toggle word wrap

3.2.205.1. Parameters
Copy link

Expand

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	a selector to restrict the list of returned objects by their labels; defaults to everything	false	string
QueryParameter	fieldSelector	a selector to restrict the list of returned objects by their fields; defaults to everything	false	string
QueryParameter	watch	watch for changes to the described resources and return them as a stream of add, update, and remove notifications; specify resourceVersion	false	boolean
QueryParameter	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	false	string

3.2.205.2. Responses
Copy link

Expand

HTTP Code	Description	Schema
200	success	Section 2.3.136, “json.WatchEvent”

3.2.205.3. Consumes
Copy link

3.2.205.4. Produces
Copy link

application/json

3.2.205.5. Tags
Copy link

apiv1

3.3. Definitions
Copy link

3.3.1. v1.PersistentVolume
Copy link

A Persistent Volume (PV) is a storage device that is made available for use by applications by an administrator. When a user requests persistent storage be allocated for a pod, they create a persistent volume claim with the size and type of storage they need. The system will look for persistent volumes that match that claim and, if one is available, it will assign that persistent volume to the claim. Information about the volume (type, location, secrets necessary to use it) will be available to the claim and the claim may then be used from a pod as a volume source.

Deleting a persistent volume removes the cluster’s record of the volume, and may result in automated processes destroying the underlying network store.

Expand

Name	Description	Required	Schema
kind	kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.106, “v1.ObjectMeta”
spec	specification of a persistent volume as provisioned by an administrator; see http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistent-volumes	false	Section 3.3.30, “v1.PersistentVolumeSpec”
status	current status of a persistent volume; populated by the system, read-only; see http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistent-volumes	false	Section 3.3.45, “v1.PersistentVolumeStatus”

3.3.2. v1.MetadataVolumeSource
Copy link

Expand

Name	Description	Required	Schema	Default
items	list of metadata files	false	Section 2.3.60, “v1.MetadataFile” array

3.3.3. v1.TCPSocketAction
Copy link

Expand

Name	Description	Required	Schema	Default
port	number or name of the port to access on the container; number must be in the range 1 to 65535; name must be an IANA_SVC_NAME	true	string

3.3.4. v1.ResourceQuotaStatus
Copy link

Expand

Name	Description	Required	Schema	Default
hard	hard is the set of enforced hard limits for each named resource; see http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota	false	Section 2.3.161, “any”
used	used is the current observed total usage of the resource in the namespace	false	Section 2.3.161, “any”

3.3.5. v1.ContainerStateTerminated
Copy link

Expand

Name	Description	Required	Schema
exitCode	exit status from the last termination of the container	true	integer (int32)
signal	signal from the last termination of the container	false	integer (int32)
reason	(brief) reason from the last termination of the container	false	string
message	message regarding the last termination of the container	false	string
startedAt	time at which previous execution of the container started	false	string (date-time)
finishedAt	time at which the container last terminated	false	string (date-time)
containerID	container’s ID in the format 'docker://<container_id>'	false	string

3.3.6. v1.ReplicationControllerList
Copy link

Expand

Name	Description	Required	Schema
kind	kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.24, “v1.ListMeta”
items	list of replication controllers; see http://releases.k8s.io/HEAD/docs/user-guide/replication-controller.md	true	Section 3.3.59, “v1.ReplicationController” array

3.3.7. v1.Capability
Copy link

3.3.8. v1.Pod
Copy link

A pod corresponds to a group of containers running together on the same machine. All containers in a pod share an IP address, and may have access to shared volumes and local filesystem. Like individual application containers, pods are considered to be relatively ephemeral rather than durable entities. Pods are scheduled to nodes and remain there until termination (according to restart policy) or deletion. When a node dies, the pods scheduled to that node are deleted. Specific pods are never rescheduled to new nodes; instead, they must be replaced by a component like the replication controller.

See the Kubernetes pod documentation for more information.

Expand

Name	Description	Required	Schema
kind	kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.106, “v1.ObjectMeta”
spec	specification of the desired behavior of the pod; http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status	false	Section 2.3.61, “v1.PodSpec”
status	most recently observed status of the pod; populated by the system, read-only; http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status	false	Section 3.3.91, “v1.PodStatus”

3.3.9. v1.Event
Copy link

Expand

Name	Description	Required	Schema
kind	kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	true	Section 2.3.106, “v1.ObjectMeta”
involvedObject	object this event is about	true	Section 2.3.122, “v1.ObjectReference”
reason	short, machine understandable string that gives the reason for the transition into the object’s current status	false	string
message	human-readable description of the status of this operation	false	string
source	component reporting this event	false	Section 3.3.55, “v1.EventSource”
firstTimestamp	the time at which the event was first recorded	false	string (date-time)
lastTimestamp	the time at which the most recent occurrence of this event was recorded	false	string (date-time)
count	the number of times this event has occurred	false	integer (int32)

3.3.10. v1.HostPathVolumeSource
Copy link

Expand

Name	Description	Required	Schema	Default
path	path of the directory on the host; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#hostpath	true	string

3.3.11. v1.Volume
Copy link

Expand

Name	Description	Required	Schema
name	volume name; must be a DNS_LABEL and unique within the pod; see http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names	true	string
hostPath	pre-existing host file or directory; generally for privileged system daemons or other agents tied to the host; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#hostpath	false	Section 2.3.15, “v1.HostPathVolumeSource”
emptyDir	temporary directory that shares a pod’s lifetime; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#emptydir	false	Section 2.3.96, “v1.EmptyDirVolumeSource”
gcePersistentDisk	GCE disk resource attached to the host machine on demand; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk	false	Section 2.3.74, “v1.GCEPersistentDiskVolumeSource”
awsElasticBlockStore	AWS disk resource attached to the host machine on demand; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore	false	Section 2.3.137, “v1.AWSElasticBlockStoreVolumeSource”
gitRepo	git repository at a particular revision	false	Section 2.3.105, “v1.GitRepoVolumeSource”
secret	secret to populate volume; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#secrets	false	Section 2.3.35, “v1.SecretVolumeSource”
nfs	NFS volume that will be mounted in the host machine; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs	false	Section 2.3.28, “v1.NFSVolumeSource”
iscsi	iSCSI disk attached to host machine on demand; see http://releases.k8s.io/HEAD/examples/iscsi/README.md	false	Section 2.3.104, “v1.ISCSIVolumeSource”
glusterfs	Glusterfs volume that will be mounted on the host machine; see http://releases.k8s.io/HEAD/examples/glusterfs/README.md	false	Section 2.3.158, “v1.GlusterfsVolumeSource”
persistentVolumeClaim	a reference to a PersistentVolumeClaim in the same namespace; see http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistentvolumeclaims	false	Section 2.3.47, “v1.PersistentVolumeClaimVolumeSource”
rbd	rados block volume that will be mounted on the host machine; see http://releases.k8s.io/HEAD/examples/rbd/README.md	false	Section 2.3.63, “v1.RBDVolumeSource”
cephfs	Ceph filesystem that will be mounted on the host machine	false	Section 2.3.29, “v1.CephFSVolumeSource”
metadata	Metadata volume containing information about the pod	false	Section 2.3.1, “v1.MetadataVolumeSource”

3.3.12. v1.ContainerStateRunning
Copy link

Expand

Name	Description	Required	Schema	Default
startedAt	time at which the container was last (re-)started	false	string (date-time)

3.3.13. v1.DeleteOptions
Copy link

Expand

Name	Description	Required	Schema
kind	kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
gracePeriodSeconds	the duration in seconds to wait before deleting this object; defaults to a per object value if not specified; zero means delete immediately	true	integer (int64)

3.3.14. v1.ListMeta
Copy link

Expand

Name	Description	Required	Schema	Default
selfLink	URL for the object; populated by the system, read-only	false	string
resourceVersion	string that identifies the internal version of this object that can be used by clients to determine when objects have changed; populated by the system, read-only; value must be treated as opaque by clients and passed unmodified back to the server: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency	false	string

3.3.15. v1.PodTemplateSpec
Copy link

Expand

Name	Description	Required	Schema	Default
metadata	standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.106, “v1.ObjectMeta”
spec	specification of the desired behavior of the pod; http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status	false	Section 2.3.61, “v1.PodSpec”

3.3.16. v1.SecretList
Copy link

Expand

Name	Description	Required	Schema
kind	kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.24, “v1.ListMeta”
items	items is a list of secret objects; see http://releases.k8s.io/HEAD/docs/user-guide/secrets.md	true	Section 3.3.87, “v1.Secret” array

3.3.17. v1.NFSVolumeSource
Copy link

Expand

Name	Description	Required	Schema	Default
server	the hostname or IP address of the NFS server; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs	true	string
path	the path that is exported by the NFS server; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs	true	string
readOnly	forces the NFS export to be mounted with read-only permissions; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs	false	boolean	false

3.3.18. v1.CephFSVolumeSource
Copy link

Expand

Name	Description	Required	Schema	Default
monitors	a collection of Ceph monitors	true	string array
user	rados user name; default is admin; optional	false	string
secretFile	path to secret for rados user; default is /etc/ceph/user.secret; optional	false	string
secretRef	name of a secret to authenticate the user; if provided overrides keyring; optional	false	Section 2.3.110, “v1.LocalObjectReference”
readOnly	Ceph fs to be mounted with read-only permissions	false	boolean	false

3.3.19. v1.Capabilities
Copy link

Expand

Name	Description	Required	Schema	Default
add	added capabilities	false	Section 2.3.8, “v1.Capability” array
drop	dropped capabilities	false	Section 2.3.8, “v1.Capability” array

3.3.20. v1.ComponentCondition
Copy link

Expand

Name	Description	Required	Schema
type	type of component condition, currently only Healthy	true	string
status	current status of this component condition, one of True, False, Unknown	true	string
message	health check message received from the component	false	string
error	error code from health check attempt (if any)	false	string

3.3.21. v1.ServiceStatus
Copy link

Expand

Name	Description	Required	Schema	Default
loadBalancer	status of load-balancer	false	Section 3.3.80, “v1.LoadBalancerStatus”

3.3.22. v1.SecretVolumeSource
Copy link

Expand

Name	Description	Required	Schema	Default
secretName	secretName is the name of a secret in the pod’s namespace; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#secrets	true	string

3.3.23. v1.ResourceRequirements
Copy link

Expand

Name	Description	Required	Schema	Default
limits	Maximum amount of compute resources allowed; see http://releases.k8s.io/HEAD/docs/design/resources.md#resource-specifications	false	Section 2.3.161, “any”
requests	Minimum amount of resources requested; if Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value; see http://releases.k8s.io/HEAD/docs/design/resources.md#resource-specifications	false	Section 2.3.161, “any”

3.3.24. v1.PersistentVolumeClaim
Copy link

Expand

Name	Description	Required	Schema
kind	kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.106, “v1.ObjectMeta”
spec	the desired characteristics of a volume; see http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistentvolumeclaims	false	Section 3.3.58, “v1.PersistentVolumeClaimSpec”
status	the current status of a persistent volume claim; read-only; see http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistentvolumeclaims	false	Section 3.3.115, “v1.PersistentVolumeClaimStatus”

3.3.25. v1.SecurityContextConstraintsList
Copy link

Expand

Name	Description	Required	Schema
kind	kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata		false	Section 2.3.24, “v1.ListMeta”
items		true	Section 3.3.61, “v1.SecurityContextConstraints” array

3.3.26. v1.NamespaceStatus
Copy link

Expand

Name	Description	Required	Schema	Default
phase	phase is the current lifecycle phase of the namespace; see http://releases.k8s.io/HEAD/docs/design/namespaces.md#phases	false	string

3.3.27. v1.PersistentVolumeAccessMode
Copy link

3.3.28. v1.ResourceQuotaSpec
Copy link

Expand

Name	Description	Required	Schema	Default
hard	hard is the set of desired hard limits for each named resource; see http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota	false	Section 2.3.161, “any”

3.3.29. v1.RunAsUserStrategyOptions
Copy link

Expand

Name	Description	Required	Schema
type	strategy used to generate RunAsUser	false	string
uid	the uid to always run as; required for MustRunAs	false	integer (int64)
uidRangeMin	min value for range based allocators	false	integer (int64)
uidRangeMax	max value for range based allocators	false	integer (int64)

3.3.30. v1.PersistentVolumeSpec
Copy link

Expand

Name	Description	Required	Schema
capacity	a description of the persistent volume’s resources and capacity; see http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#capacity	false	Section 2.3.161, “any”
gcePersistentDisk	GCE disk resource provisioned by an admin; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk	false	Section 2.3.74, “v1.GCEPersistentDiskVolumeSource”
awsElasticBlockStore	AWS disk resource provisioned by an admin; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore	false	Section 2.3.137, “v1.AWSElasticBlockStoreVolumeSource”
hostPath	a HostPath provisioned by a developer or tester; for development use only; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#hostpath	false	Section 2.3.15, “v1.HostPathVolumeSource”
glusterfs	Glusterfs volume resource provisioned by an admin; see http://releases.k8s.io/HEAD/examples/glusterfs/README.md	false	Section 2.3.158, “v1.GlusterfsVolumeSource”
nfs	NFS volume resource provisioned by an admin; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs	false	Section 2.3.28, “v1.NFSVolumeSource”
rbd	rados block volume that will be mounted on the host machine; see http://releases.k8s.io/HEAD/examples/rbd/README.md	false	Section 2.3.63, “v1.RBDVolumeSource”
iscsi	an iSCSI disk resource provisioned by an admin	false	Section 2.3.104, “v1.ISCSIVolumeSource”
cephfs	Ceph filesystem that will be mounted on the host machine	false	Section 2.3.29, “v1.CephFSVolumeSource”
accessModes	all ways the volume can be mounted; see http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#access-modes	false	Section 3.3.27, “v1.PersistentVolumeAccessMode” array
claimRef	when bound, a reference to the bound claim; see http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#binding	false	Section 2.3.122, “v1.ObjectReference”
persistentVolumeReclaimPolicy	what happens to a volume when released from its claim; Valid options are Retain (default) and Recycle. Recyling must be supported by the volume plugin underlying this persistent volume. See http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#recycling-policy	false	string

3.3.31. v1.ExecAction
Copy link

Expand

Name	Description	Required	Schema	Default
command	command line to execute inside the container; working directory for the command is root ('/') in the container’s file system; the command is exec’d, not run inside a shell; exit status of 0 is treated as live/healthy and non-zero is unhealthy	false	string array

3.3.32. v1.PersistentVolumeClaimVolumeSource
Copy link

Expand

Name	Description	Required	Schema	Default
claimName	the name of the claim in the same namespace to be mounted as a volume; see http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistentvolumeclaims	true	string
readOnly	mount volume as read-only when true; default false	false	boolean	false

3.3.33. v1.ServiceSpec
Copy link

Expand

Name	Description	Required	Schema
ports	ports exposed by the service; see http://releases.k8s.io/HEAD/docs/user-guide/services.md#virtual-ips-and-service-proxies	true	Section 3.3.49, “v1.ServicePort” array
selector	label keys and values that must match in order to receive traffic for this service; if empty, all pods are selected, if not specified, endpoints must be manually specified; see http://releases.k8s.io/HEAD/docs/user-guide/services.md#overview	false	Section 2.3.161, “any”
portalIP	deprecated, use clusterIP instead	false	string
clusterIP	IP address of the service; usually assigned by the system; if specified, it will be allocated to the service if unused or else creation of the service will fail; cannot be updated; 'None' can be specified for a headless service when proxying is not required; see http://releases.k8s.io/HEAD/docs/user-guide/services.md#virtual-ips-and-service-proxies	false	string
type	type of this service; must be ClusterIP, NodePort, or LoadBalancer; defaults to ClusterIP; see http://releases.k8s.io/HEAD/docs/user-guide/services.md#external-services	false	string
deprecatedPublicIPs	deprecated. externally visible IPs (e.g. load balancers) that should be proxied to this service	false	string array
sessionAffinity	enable client IP based session affinity; must be ClientIP or None; defaults to None; see http://releases.k8s.io/HEAD/docs/user-guide/services.md#virtual-ips-and-service-proxies	false	string

3.3.34. v1.ServiceList
Copy link

Expand

Name	Description	Required	Schema
kind	kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.24, “v1.ListMeta”
items	list of services	true	Section 3.3.93, “v1.Service” array

3.3.35. v1.PersistentVolumeList
Copy link

Expand

Name	Description	Required	Schema
kind	kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	Section 2.3.24, “v1.ListMeta”
items	list of persistent volumes; see http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md	false	Section 3.3.1, “v1.PersistentVolume” array

3.3.36. v1.ContainerStatus
Copy link

Expand

Name	Description	Required	Schema	Default
name	name of the container; must be a DNS_LABEL and unique within the pod; cannot be updated	true	string
state	details about the container’s current condition	false	Section 3.3.88, “v1.ContainerState”
lastState	details about the container’s last termination condition	false	Section 3.3.88, “v1.ContainerState”
ready	specifies whether the container has passed its readiness probe	true	boolean	false
restartCount	the number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed	true	integer (int32)
image	image of the container; see http://releases.k8s.io/HEAD/docs/user-guide/images.md	true	string
imageID	ID of the container’s image	true	string
containerID	container’s ID in the format 'docker://<container_id>'; see http://releases.k8s.io/HEAD/docs/user-guide/container-environment.md#container-information	false	string

3.3.37. v1.Handler
Copy link

Expand

Name	Description	Required	Schema
exec	exec-based handler	false	Section 2.3.45, “v1.ExecAction”
httpGet	HTTP-based handler	false	Section 2.3.99, “v1.HTTPGetAction”
tcpSocket	TCP-based handler; TCP hooks not yet supported	false	Section 2.3.2, “v1.TCPSocketAction”

3.3.38. v1.NodeAddress
Copy link

Expand

Name	Description	Required	Schema	Default
type	node address type, one of Hostname, ExternalIP or InternalIP	true	string
address	the node address	true	string

3.3.39. v1.EndpointPort
Copy link

Expand

Name	Description	Required	Schema
name	name of this port	false	string
port	port number of the endpoint	true	integer (int32)
protocol	protocol for this port; must be UDP or TCP; TCP if unspecified	false	string

3.3.40. v1.EndpointSubset
Copy link

Expand

Name	Description	Required	Schema	Default
addresses	IP addresses which offer the related ports	false	Section 3.3.101, “v1.EndpointAddress” array
ports	port numbers available on the related IP addresses	false	Section 3.3.39, “v1.EndpointPort” array

3.3.41. v1.LimitRangeList
Copy link

Expand

Name	Description	Required	Schema
kind	kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.24, “v1.ListMeta”
items	items is a list of LimitRange objects; see http://releases.k8s.io/HEAD/docs/design/admission_control_limit_range.md	true	Section 3.3.113, “v1.LimitRange” array

3.3.42. v1.Container
Copy link

Expand

Name	Description	Required	Schema	Default
name	name of the container; must be a DNS_LABEL and unique within the pod; cannot be updated	true	string
image	Docker image name; see http://releases.k8s.io/HEAD/docs/user-guide/images.md	false	string
command	entrypoint array; not executed within a shell; the Docker image’s entrypoint is used if this is not provided; cannot be updated; variable references $(VAR_NAME) are expanded using the container’s environment variables; 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; see http://releases.k8s.io/HEAD/docs/user-guide/containers.md#containers-and-commands	false	string array
args	command array; the Docker image’s cmd is used if this is not provided; arguments to the entrypoint; cannot be updated; variable references $(VAR_NAME) are expanded using the container’s environment variables; 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; see http://releases.k8s.io/HEAD/docs/user-guide/containers.md#containers-and-commands	false	string array
workingDir	container’s working directory; defaults to image’s default; cannot be updated	false	string
ports	list of ports to expose from the container; cannot be updated	false	Section 2.3.116, “v1.ContainerPort” array
env	list of environment variables to set in the container; cannot be updated	false	Section 2.3.149, “v1.EnvVar” array
resources	Compute Resources required by this container; cannot be updated; see http://releases.k8s.io/HEAD/docs/user-guide/compute-resources.md	false	Section 2.3.37, “v1.ResourceRequirements”
volumeMounts	pod volumes to mount into the container’s filesystem; cannot be updated	false	Section 2.3.83, “v1.VolumeMount” array
livenessProbe	periodic probe of container liveness; container will be restarted if the probe fails; cannot be updated; see http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes	false	Section 2.3.102, “v1.Probe”
readinessProbe	periodic probe of container service readiness; container will be removed from service endpoints if the probe fails; cannot be updated; see http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes	false	Section 2.3.102, “v1.Probe”
lifecycle	actions that the management system should take in response to container lifecycle events; cannot be updated	false	Section 2.3.129, “v1.Lifecycle”
terminationMessagePath	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; defaults to /dev/termination-log; cannot be updated	false	string
imagePullPolicy	image pull policy; one of Always, Never, IfNotPresent; defaults to Always if :latest tag is specified, or IfNotPresent otherwise; cannot be updated; see http://releases.k8s.io/HEAD/docs/user-guide/images.md#updating-images	false	string
securityContext	security options the pod should run with; see http://releases.k8s.io/HEAD/docs/design/security_context.md	false	Section 2.3.68, “v1.SecurityContext”
stdin	Whether this container should allocate a buffer for stdin in the container runtime; default is false	false	boolean	false
tty	Whether this container should allocate a TTY for itself, also requires 'stdin' to be true; default is false	false	boolean	false

3.3.43. v1.MetadataFile
Copy link

Expand

Name	Description	Required	Schema	Default
name	the name of the file to be created	true	string
fieldRef	selects a field of the pod. Supported fields: metadata.annotations, metadata.labels, metadata.name, metadata.namespace	true	Section 2.3.127, “v1.ObjectFieldSelector”

3.3.44. v1.PodSpec
Copy link

Expand

Name	Description	Required	Schema	Default
volumes	list of volumes that can be mounted by containers belonging to the pod; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md	false	Section 2.3.18, “v1.Volume” array
containers	list of containers belonging to the pod; cannot be updated; containers cannot currently be added or removed; there must be at least one container in a Pod; see http://releases.k8s.io/HEAD/docs/user-guide/containers.md	true	Section 2.3.58, “v1.Container” array
restartPolicy	restart policy for all containers within the pod; one of Always, OnFailure, Never; defaults to Always; see http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#restartpolicy	false	string
terminationGracePeriodSeconds	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 not set, 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	false	integer (int64)
activeDeadlineSeconds		false	integer (int64)
dnsPolicy	DNS policy for containers within the pod; one of 'ClusterFirst' or 'Default'	false	string
nodeSelector	selector which must match a node’s labels for the pod to be scheduled on that node; see http://releases.k8s.io/HEAD/docs/user-guide/node-selection/README.md	false	Section 2.3.161, “any”
host	deprecated, use nodeName instead	false	string
serviceAccountName	name of the ServiceAccount to use to run this pod; see http://releases.k8s.io/HEAD/docs/design/service_accounts.md	false	string
serviceAccount	deprecated; use serviceAccountName instead	false	string
nodeName	node requested for this pod	false	string
hostNetwork	host networking requested for this pod	false	boolean	false
imagePullSecrets	list of references to secrets in the same namespace available for pulling the container images; see http://releases.k8s.io/HEAD/docs/user-guide/images.md#specifying-imagepullsecrets-on-a-pod	false	Section 2.3.110, “v1.LocalObjectReference” array

3.3.45. v1.PersistentVolumeStatus
Copy link

Expand

Name	Description	Required	Schema
phase	the current phase of a persistent volume; see http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#phase	false	string
message	human-readable message indicating details about why the volume is in this state	false	string
reason	(brief) reason the volume is not is not available	false	string

3.3.46. v1.RBDVolumeSource
Copy link

Expand

Name	Description	Required	Schema	Default
monitors	a collection of Ceph monitors; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it	true	string array
image	rados image name; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it	true	string
fsType	file system type to mount, such as ext4, xfs, ntfs; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it	false	string
pool	rados pool name; default is rbd; optional; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it	true	string
user	rados user name; default is admin; optional; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it	true	string
keyring	keyring is the path to key ring for rados user; default is /etc/ceph/keyring; optional; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it	true	string
secretRef	name of a secret to authenticate the RBD user; if provided overrides keyring; optional; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it	true	Section 2.3.110, “v1.LocalObjectReference”
readOnly	rbd volume to be mounted with read-only permissions; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it	false	boolean	false

3.3.47. v1.LoadBalancerIngress
Copy link

Expand

Name	Description	Required	Schema	Default
ip	IP address of ingress point	false	string
hostname	hostname of ingress point	false	string

3.3.48. v1.SecurityContext
Copy link

Expand

Name	Description	Required	Schema	Default
capabilities	the Linux capabilites that should be added or removed; see http://releases.k8s.io/HEAD/docs/design/security_context.md#security-context	false	Section 2.3.30, “v1.Capabilities”
privileged	run the container in privileged mode; see http://releases.k8s.io/HEAD/docs/design/security_context.md#security-context	false	boolean	false
seLinuxOptions	options that control the SELinux labels applied; see http://releases.k8s.io/HEAD/docs/design/security_context.md#security-context	false	Section 2.3.121, “v1.SELinuxOptions”
runAsUser	the user id that runs the first process in the container; see http://releases.k8s.io/HEAD/docs/design/security_context.md#security-context	false	integer (int64)
runAsNonRoot	indicates the container must be run as a non-root user either by specifying the runAsUser or in the image specification	false	boolean	false

3.3.49. v1.ServicePort
Copy link

Expand

Name	Description	Required	Schema
name	the name of this port; optional if only one port is defined	false	string
protocol	the protocol used by this port; must be UDP or TCP; TCP if unspecified	false	string
port	the port number that is exposed	true	integer (int32)
targetPort	number or name of the port to access on the pods targeted by the service; defaults to the service port; number must be in the range 1 to 65535; name must be an IANA_SVC_NAME; see http://releases.k8s.io/HEAD/docs/user-guide/services.md#defining-a-service	false	string
nodePort	the port on each node on which this service is exposed when type=NodePort or LoadBalancer; usually assigned by the system; if specified, it will be allocated to the service if unused or else creation of the service will fail; see http://releases.k8s.io/HEAD/docs/user-guide/services.md#type—nodeport	true	integer (int32)

3.3.50. v1.StatusCause
Copy link

Expand

Name	Description	Required	Schema
reason	machine-readable description of the cause of the error; if this value is empty there is no information available	false	string
message	human-readable description of the cause of the error; this field may be presented as-is to a reader	false	string
field	field of the resource that has caused this error, as named by its JSON serialization; may include dot and postfix notation for nested attributes; arrays are zero-indexed; fields may appear more than once in an array of causes due to fields having multiple errors	false	string

3.3.51. v1.Namespace
Copy link

Expand

Name	Description	Required	Schema
kind	kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.106, “v1.ObjectMeta”
spec	spec defines the behavior of the Namespace; http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status	false	Section 3.3.77, “v1.NamespaceSpec”
status	status describes the current status of a Namespace; http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status	false	Section 3.3.26, “v1.NamespaceStatus”

3.3.52. v1.GCEPersistentDiskVolumeSource
Copy link

Expand

Name	Description	Required	Schema	Default
pdName	unique name of the PD resource in GCE; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk	true	string
fsType	file system type to mount, such as ext4, xfs, ntfs; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk	true	string
partition	partition on the disk to mount (e.g., '1' for /dev/sda1); if omitted the plain device name (e.g., /dev/sda) will be mounted; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk	false	integer (int32)
readOnly	read-only if true, read-write otherwise (false or unspecified); see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk	false	boolean	false

3.3.53. v1.EndpointsList
Copy link

Expand

Name	Description	Required	Schema
kind	kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.24, “v1.ListMeta”
items	list of endpoints	true	Section 3.3.89, “v1.Endpoints” array

3.3.54. v1.NodeList
Copy link

Expand

Name	Description	Required	Schema
kind	kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.24, “v1.ListMeta”
items	list of nodes	true	Section 3.3.104, “v1.Node” array

3.3.55. v1.EventSource
Copy link

Expand

Name	Description	Required	Schema	Default
component	component that generated the event	false	string
host	name of the host where the event is generated	false	string

3.3.56. v1.EnvVarSource
Copy link

Expand

Name	Description	Required	Schema	Default
fieldRef	selects a field of the pod; only name and namespace are supported	true	Section 2.3.127, “v1.ObjectFieldSelector”

3.3.57. v1.LimitRangeSpec
Copy link

Expand

Name	Description	Required	Schema	Default
limits	limits is the list of LimitRangeItem objects that are enforced	true	Section 3.3.111, “v1.LimitRangeItem” array

3.3.58. v1.PersistentVolumeClaimSpec
Copy link

Expand

Name	Description	Required	Schema
accessModes	the desired access modes the volume should have; see http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#access-modes-1	false	Section 3.3.27, “v1.PersistentVolumeAccessMode” array
resources	the desired resources the volume should have; see http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#resources	false	Section 2.3.37, “v1.ResourceRequirements”
volumeName	the binding reference to the persistent volume backing this claim	false	string

3.3.59. v1.ReplicationController
Copy link

Expand

Name	Description	Required	Schema
kind	kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.106, “v1.ObjectMeta”
spec	specification of the desired behavior of the replication controller; http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status	false	Section 3.3.108, “v1.ReplicationControllerSpec”
status	most recently observed status of the replication controller; populated by the system, read-only; http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status	false	Section 3.3.64, “v1.ReplicationControllerStatus”

3.3.60. v1.NamespaceList
Copy link

Expand

Name	Description	Required	Schema
kind	kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.24, “v1.ListMeta”
items	items is the list of Namespace objects in the list; see http://releases.k8s.io/HEAD/docs/user-guide/namespaces.md	true	Section 3.3.51, “v1.Namespace” array

3.3.61. v1.SecurityContextConstraints
Copy link

Expand

Name	Description	Required	Schema	Default
kind	kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata		false	Section 2.3.106, “v1.ObjectMeta”
allowPrivilegedContainer	allow containers to run as privileged	true	boolean	false
allowedCapabilities	capabilities that are allowed to be added	true	Section 2.3.8, “v1.Capability” array
allowHostDirVolumePlugin	allow the use of the host dir volume plugin	true	boolean	false
allowHostNetwork	allow the use of the hostNetwork in the pod spec	true	boolean	false
allowHostPorts	allow the use of the host ports in the containers	true	boolean	false
seLinuxContext	strategy used to generate SELinuxOptions	false	Section 3.3.90, “v1.SELinuxContextStrategyOptions”
runAsUser	strategy used to generate RunAsUser	false	Section 3.3.29, “v1.RunAsUserStrategyOptions”
users	users allowed to use this SecurityContextConstraints	false	string array
groups	groups allowed to use this SecurityContextConstraints	false	string array

3.3.62. v1.VolumeMount
Copy link

Expand

Name	Description	Required	Schema	Default
name	name of the volume to mount	true	string
readOnly	mounted read-only if true, read-write otherwise (false or unspecified)	false	boolean	false
mountPath	path within the container at which the volume should be mounted	true	string

3.3.63. v1.NodeStatus
Copy link

Expand

Name	Description	Required	Schema
capacity	compute resource capacity of the node; see http://releases.k8s.io/HEAD/docs/user-guide/compute-resources.md	false	Section 2.3.161, “any”
phase	most recently observed lifecycle phase of the node; see http://releases.k8s.io/HEAD/docs/admin/node.md#node-phase	false	string
conditions	list of node conditions observed; see http://releases.k8s.io/HEAD/docs/admin/node.md#node-condition	false	Section 3.3.66, “v1.NodeCondition” array
addresses	list of addresses reachable to the node; see http://releases.k8s.io/HEAD/docs/admin/node.md#node-addresses	false	Section 3.3.38, “v1.NodeAddress” array
nodeInfo	set of ids/uuids to uniquely identify the node; see http://releases.k8s.io/HEAD/docs/admin/node.md#node-info	false	Section 3.3.99, “v1.NodeSystemInfo”

3.3.64. v1.ReplicationControllerStatus
Copy link

Expand

Name	Description	Required	Schema	Default
replicas	most recently observed number of replicas; see http://releases.k8s.io/HEAD/docs/user-guide/replication-controller.md#what-is-a-replication-controller	true	integer (int32)
observedGeneration	reflects the generation of the most recently observed replication controller	false	integer (int64)

3.3.65. v1.PodCondition
Copy link

Expand

Name	Description	Required	Schema	Default
type	kind of the condition, currently only Ready; see http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#pod-conditions	true	string
status	status of the condition, one of True, False, Unknown; see http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#pod-conditions	true	string

3.3.66. v1.NodeCondition
Copy link

Expand

Name	Description	Required	Schema
type	type of node condition, currently only Ready	true	string
status	status of the condition, one of True, False, Unknown	true	string
lastHeartbeatTime	last time we got an update on a given condition	false	string (date-time)
lastTransitionTime	last time the condition transit from one status to another	false	string (date-time)
reason	(brief) reason for the condition’s last transition	false	string
message	human readable message indicating details about last transition	false	string

3.3.67. v1.ServiceAccount
Copy link

Expand

Name	Description	Required	Schema
kind	kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.106, “v1.ObjectMeta”
secrets	list of secrets that can be used by pods running as this service account; see http://releases.k8s.io/HEAD/docs/user-guide/secrets.md	false	Section 2.3.122, “v1.ObjectReference” array
imagePullSecrets	list of references to secrets in the same namespace available for pulling container images; see http://releases.k8s.io/HEAD/docs/user-guide/secrets.md#manually-specifying-an-imagepullsecret	false	Section 2.3.110, “v1.LocalObjectReference” array

3.3.68. v1.PodTemplate
Copy link

Expand

Name	Description	Required	Schema
kind	kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.106, “v1.ObjectMeta”
template	the template of the desired behavior of the pod; http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status	false	Section 2.3.25, “v1.PodTemplateSpec”

3.3.69. v1.PodList
Copy link

Expand

Name	Description	Required	Schema
kind	kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	Section 2.3.24, “v1.ListMeta”
items	list of pods; see http://releases.k8s.io/HEAD/docs/user-guide/pods.md	true	Section 3.3.8, “v1.Pod” array

3.3.70. v1.EmptyDirVolumeSource
Copy link

Expand

Name	Description	Required	Schema	Default
medium	type of storage used to back the volume; must be an empty string (default) or Memory; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#emptydir	false	string

3.3.71. v1.NodeSpec
Copy link

Expand

Name	Description	Required	Schema	Default
podCIDR	pod IP range assigned to the node	false	string
externalID	deprecated. External ID assigned to the node by some machine database (e.g. a cloud provider). Defaults to node name when empty.	false	string
providerID	ID of the node assigned by the cloud provider in the format: <ProviderName>://<ProviderSpecificNodeID>	false	string
unschedulable	disable pod scheduling on the node; see http://releases.k8s.io/HEAD/docs/admin/node.md#manual-node-administration	false	boolean	false

3.3.72. api.Patch
Copy link

3.3.73. v1.HTTPGetAction
Copy link

Expand

Name	Description	Required	Schema
path	path to access on the HTTP server	false	string
port	number or name of the port to access on the container; number must be in the range 1 to 65535; name must be an IANA_SVC_NAME	true	string
host	hostname to connect to; defaults to pod IP	false	string
scheme	scheme to connect with, must be HTTP or HTTPS, defaults to HTTP	false	string

3.3.74. v1.ResourceQuotaList
Copy link

Expand

Name	Description	Required	Schema
kind	kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.24, “v1.ListMeta”
items	items is a list of ResourceQuota objects; see http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota	true	Section 3.3.106, “v1.ResourceQuota” array

3.3.75. v1.ServiceAccountList
Copy link

Expand

Name	Description	Required	Schema
kind	kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.24, “v1.ListMeta”
items	list of ServiceAccounts; see http://releases.k8s.io/HEAD/docs/design/service_accounts.md#service-accounts	true	Section 3.3.67, “v1.ServiceAccount” array

3.3.76. v1.Probe
Copy link

Expand

Name	Description	Required	Schema
exec	exec-based handler	false	Section 2.3.45, “v1.ExecAction”
httpGet	HTTP-based handler	false	Section 2.3.99, “v1.HTTPGetAction”
tcpSocket	TCP-based handler; TCP hooks not yet supported	false	Section 2.3.2, “v1.TCPSocketAction”
initialDelaySeconds	number of seconds after the container has started before liveness probes are initiated; see http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes	false	integer (int64)
timeoutSeconds	number of seconds after which liveness probes timeout; defaults to 1 second; see http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes	false	integer (int64)

3.3.77. v1.NamespaceSpec
Copy link

Expand

Name	Description	Required	Schema	Default
finalizers	an opaque list of values that must be empty to permanently remove object from storage; see http://releases.k8s.io/HEAD/docs/design/namespaces.md#finalizers	false	Section 2.3.155, “v1.FinalizerName” array

3.3.78. v1.ISCSIVolumeSource
Copy link

Expand

Name	Description	Required	Schema	Default
targetPortal	iSCSI target portal	true	string
iqn	iSCSI Qualified Name	true	string
lun	iscsi target lun number	true	integer (int32)
fsType	file system type to mount, such as ext4, xfs, ntfs	true	string
readOnly	read-only if true, read-write otherwise (false or unspecified)	false	boolean	false

3.3.79. v1.EventList
Copy link

Expand

Name	Description	Required	Schema
kind	kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.24, “v1.ListMeta”
items	list of events	true	Section 3.3.9, “v1.Event” array

3.3.80. v1.LoadBalancerStatus
Copy link

Expand

Name	Description	Required	Schema	Default
ingress	load-balancer ingress points	false	Section 3.3.47, “v1.LoadBalancerIngress” array

3.3.81. v1.PersistentVolumeClaimList
Copy link

Expand

Name	Description	Required	Schema
kind	kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	Section 2.3.24, “v1.ListMeta”
items	a list of persistent volume claims; see http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistentvolumeclaims	false	Section 3.3.24, “v1.PersistentVolumeClaim” array

3.3.82. v1.ComponentStatus
Copy link

Expand

Name	Description	Required	Schema
kind	kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.106, “v1.ObjectMeta”
conditions	list of component conditions observed	false	Section 3.3.20, “v1.ComponentCondition” array

3.3.83. v1.GitRepoVolumeSource
Copy link

Expand

Name	Description	Required	Schema	Default
repository	repository URL	true	string
revision	commit hash for the specified revision	true	string

3.3.84. v1.ObjectMeta
Copy link

Expand

Name	Description	Required	Schema
name	string that identifies an object. Must be unique within a namespace; cannot be updated; see http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names	false	string
generateName	an optional prefix to use to generate a unique name; has the same validation rules as name; optional, and is applied only name if is not specified; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#idempotency	false	string
namespace	namespace of the object; must be a DNS_LABEL; cannot be updated; see http://releases.k8s.io/HEAD/docs/user-guide/namespaces.md	false	string
selfLink	URL for the object; populated by the system, read-only	false	string
uid	unique UUID across space and time; populated by the system; read-only; see http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#uids	false	string
resourceVersion	string that identifies the internal version of this object that can be used by clients to determine when objects have changed; populated by the system, read-only; value must be treated as opaque by clients and passed unmodified back to the server: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency	false	string
generation	a sequence number representing a specific generation of the desired state; populated by the system; read-only	false	integer (int64)
creationTimestamp	RFC 3339 date and time at which the object was created; populated by the system, read-only; null for lists; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	string (date-time)
deletionTimestamp	RFC 3339 date and time at which the object will be deleted; populated by the system when a graceful deletion is requested, read-only; if not set, graceful deletion of the object has not been requested; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	string (date-time)
labels	map of string keys and values that can be used to organize and categorize objects; may match selectors of replication controllers and services; see http://releases.k8s.io/HEAD/docs/user-guide/labels.md	false	Section 2.3.161, “any”
annotations	map of string keys and values that can be used by external tooling to store and retrieve arbitrary metadata about objects; see http://releases.k8s.io/HEAD/docs/user-guide/annotations.md	false	Section 2.3.161, “any”

3.3.85. v1.LocalObjectReference
Copy link

Expand

Name	Description	Required	Schema	Default
name	name of the referent; see http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names	false	string

3.3.86. v1.ContainerPort
Copy link

Expand

Name	Description	Required	Schema
name	name for the port that can be referred to by services; must be an IANA_SVC_NAME and unique within the pod	false	string
hostPort	number of port to expose on the host; most containers do not need this	false	integer (int32)
containerPort	number of port to expose on the pod’s IP address	true	integer (int32)
protocol	protocol for port; must be UDP or TCP; TCP if unspecified	false	string
hostIP	host IP to bind the port to	false	string

3.3.87. v1.Secret
Copy link

Expand

Name	Description	Required	Schema
kind	kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.106, “v1.ObjectMeta”
data	data contains the secret data. Each key must be a valid DNS_SUBDOMAIN or leading dot followed by valid DNS_SUBDOMAIN. Each value must be a base64 encoded string as described in https://tools.ietf.org/html/rfc4648#section-4	false	Section 2.3.161, “any”
type	type facilitates programmatic handling of secret data	false	string

3.3.88. v1.ContainerState
Copy link

Expand

Name	Description	Required	Schema
waiting	details about a waiting container	false	Section 3.3.109, “v1.ContainerStateWaiting”
running	details about a running container	false	Section 3.3.12, “v1.ContainerStateRunning”
terminated	details about a terminated container	false	Section 3.3.5, “v1.ContainerStateTerminated”

3.3.89. v1.Endpoints
Copy link

Expand

Name	Description	Required	Schema
kind	kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.106, “v1.ObjectMeta”
subsets	sets of addresses and ports that comprise a service	true	Section 3.3.40, “v1.EndpointSubset” array

3.3.90. v1.SELinuxContextStrategyOptions
Copy link

Expand

Name	Description	Required	Schema	Default
type	strategy used to generate the SELinux context	false	string
seLinuxOptions	seLinuxOptions required to run as; required for MustRunAs	false	Section 2.3.121, “v1.SELinuxOptions”

3.3.91. v1.PodStatus
Copy link

Expand

Name	Description	Required	Schema
phase	current condition of the pod; see http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#pod-phase	false	string
conditions	current service state of pod; see http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#pod-conditions	false	Section 3.3.65, “v1.PodCondition” array
message	human readable message indicating details about why the pod is in this condition	false	string
reason	(brief-CamelCase) reason indicating details about why the pod is in this condition	false	string
hostIP	IP address of the host to which the pod is assigned; empty if not yet scheduled	false	string
podIP	IP address allocated to the pod; routable at least within the cluster; empty if not yet allocated	false	string
startTime	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.	false	string (date-time)
containerStatuses	list of container statuses; see http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-statuses	false	Section 3.3.36, “v1.ContainerStatus” array

3.3.92. v1.SELinuxOptions
Copy link

Expand

Name	Description	Required	Schema
user	the user label to apply to the container; see http://releases.k8s.io/HEAD/docs/user-guide/labels.md	false	string
role	the role label to apply to the container; see http://releases.k8s.io/HEAD/docs/user-guide/labels.md	false	string
type	the type label to apply to the container; see http://releases.k8s.io/HEAD/docs/user-guide/labels.md	false	string
level	the level label to apply to the container; see http://releases.k8s.io/HEAD/docs/user-guide/labels.md	false	string

3.3.93. v1.Service
Copy link

A Service is an abstraction which defines a logical set of Pods and a policy by which to access them - sometimes called a micro-service. The set of Pods targeted by a Service is (usually) determined by a Label selector. Services broadly fall into two types - those that load balance a set of Pods and hide which Pod a client talks to (clusterIP set to an IP address), and those where clients want to talk to the individual member pods directly (clusterIP set to 'None', also known as 'headless' services). The cluster IP of a service is exposed as an environment variable in each pod in the same namespace.

Services may be exposed only inside the cluster (type ClusterIP), inside the cluster and on a high port on each node (type NodePort), or exposed to a load balancer via the hosting cloud infrastructure (type LoadBalancer). Services with a ClusterIP may choose to map the ports available on the ClusterIP to different ports on the pods. Each service has a DNS entry of the form <name>.<namespace>.svc.cluster.local that will be valid from other pods in the cluster.

If the selector for pods is not specified, the service endpoints may be managed by the client directly. Update the endpoint resource to program the service - this can be used to inject external network services into a namsepace.

See the Kubernetes service documentation for more information.

Expand

Name	Description	Required	Schema
kind	kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.106, “v1.ObjectMeta”
spec	specification of the desired behavior of the service; http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status	false	Section 3.3.33, “v1.ServiceSpec”
status	most recently observed status of the service; populated by the system, read-only; http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status	false	Section 3.3.21, “v1.ServiceStatus”

3.3.94. v1.ObjectReference
Copy link

Expand

Name	Description	Required	Schema
kind	kind of the referent; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
namespace	namespace of the referent; see http://releases.k8s.io/HEAD/docs/user-guide/namespaces.md	false	string
name	name of the referent; see http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names	false	string
uid	uid of the referent; see http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#uids	false	string
apiVersion	API version of the referent	false	string
resourceVersion	specific resourceVersion to which this reference is made, if any: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency	false	string
fieldPath	if referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]	false	string

3.3.95. v1.ObjectFieldSelector
Copy link

Expand

Name	Description	Required	Schema	Default
apiVersion	version of the schema that fieldPath is written in terms of; defaults to v1	false	string
fieldPath	path of the field to select in the specified API version	true	string

3.3.96. v1.ComponentStatusList
Copy link

Expand

Name	Description	Required	Schema
kind	kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.24, “v1.ListMeta”
items	list of component status objects	true	Section 3.3.82, “v1.ComponentStatus” array

3.3.97. v1.Lifecycle
Copy link

Expand

Name	Description	Required	Schema	Default
postStart	called immediately after a container is started; if the handler fails, the container is terminated and restarted according to its restart policy; other management of the container blocks until the hook completes; see http://releases.k8s.io/HEAD/docs/user-guide/container-environment.md#hook-details	false	Section 2.3.57, “v1.Handler”
preStop	called before a container is terminated; the container is terminated after the handler completes; other management of the container blocks until the hook completes; see http://releases.k8s.io/HEAD/docs/user-guide/container-environment.md#hook-details	false	Section 2.3.57, “v1.Handler”

3.3.98. v1.Status
Copy link

Expand

Name	Description	Required	Schema
kind	kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.24, “v1.ListMeta”
status	status of the operation; either Success, or Failure; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status	false	string
message	human-readable description of the status of this operation	false	string
reason	machine-readable description of why this operation is in the 'Failure' status; if this value is empty there is no information available; a reason clarifies an HTTP status code but does not override it	false	string
details	extended data associated with the reason; each reason may define its own extended details; this field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type	false	Section 2.3.143, “v1.StatusDetails”
code	suggested HTTP return code for this status; 0 if not set	false	integer (int32)

3.3.99. v1.NodeSystemInfo
Copy link

Expand

Name	Description	Required	Schema
machineID	machine-id reported by the node	true	string
systemUUID	system-uuid reported by the node	true	string
bootID	boot id is the boot-id reported by the node	true	string
kernelVersion	Kernel version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64)	true	string
osImage	OS image used reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy))	true	string
containerRuntimeVersion	Container runtime version reported by the node through runtime remote API (e.g. docker://1.5.0)	true	string
kubeletVersion	Kubelet version reported by the node	true	string
kubeProxyVersion	Kube-proxy version reported by the node	true	string

3.3.100. json.WatchEvent
Copy link

Expand

Name	Description	Required	Schema	Default
type	the type of watch event; may be ADDED, MODIFIED, DELETED, or ERROR	false	string
object	the object being watched; will match the type of the resource endpoint or be a Status object if the type is ERROR	false	string

3.3.101. v1.EndpointAddress
Copy link

Expand

Name	Description	Required	Schema	Default
ip	IP address of the endpoint	true	string
targetRef	reference to object providing the endpoint	false	Section 2.3.122, “v1.ObjectReference”

3.3.102. v1.AWSElasticBlockStoreVolumeSource
Copy link

Expand

Name	Description	Required	Schema	Default
volumeID	unique id of the PD resource in AWS; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore	true	string
fsType	file system type to mount, such as ext4, xfs, ntfs; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore	true	string
partition	partition on the disk to mount (e.g., '1' for /dev/sda1); if omitted the plain device name (e.g., /dev/sda) will be mounted; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore	false	integer (int32)
readOnly	read-only if true, read-write otherwise (false or unspecified); see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore	false	boolean	false

3.3.103. v1.Binding
Copy link

Expand

Name	Description	Required	Schema
kind	kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.106, “v1.ObjectMeta”
target	an object to bind to	true	Section 2.3.122, “v1.ObjectReference”

3.3.104. v1.Node
Copy link

Nodes represent the machines that run the pods and containers in the cluster. A node resource is typically created and modified by the software running on the node - reporting information about capacity and the current health of the node. The labels of the node can be used by pods to specify a subset of the cluster to be scheduled on. The scheduler will only assign pods to nodes that have the schedulable condition set and also ready.

Expand

Name	Description	Required	Schema
kind	kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.106, “v1.ObjectMeta”
spec	specification of a node; http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status	false	Section 3.3.71, “v1.NodeSpec”
status	most recently observed status of the node; populated by the system, read-only; http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status	false	Section 3.3.63, “v1.NodeStatus”

3.3.105. v1.StatusDetails
Copy link

Expand

Name	Description	Required	Schema
name	the name attribute of the resource associated with the status StatusReason (when there is a single name which can be described)	false	string
kind	the kind attribute of the resource associated with the status StatusReason; on some operations may differ from the requested resource Kind; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
causes	the Causes array includes more details associated with the StatusReason failure; not all StatusReasons may provide detailed causes	false	Section 2.3.70, “v1.StatusCause” array
retryAfterSeconds	the number of seconds before the client should attempt to retry this operation	false	integer (int32)

3.3.106. v1.ResourceQuota
Copy link

Expand

Name	Description	Required	Schema
kind	kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.106, “v1.ObjectMeta”
spec	spec defines the desired quota; http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status	false	Section 3.3.28, “v1.ResourceQuotaSpec”
status	status defines the actual enforced quota and current usage; http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status	false	Section 3.3.4, “v1.ResourceQuotaStatus”

3.3.107. v1.EnvVar
Copy link

Expand

Name	Description	Required	Schema
name	name of the environment variable; must be a C_IDENTIFIER	true	string
value	value of the environment variable; defaults to empty string; variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables; 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	false	string
valueFrom	source for the environment variable’s value; cannot be used if value is not empty	false	Section 2.3.77, “v1.EnvVarSource”

3.3.108. v1.ReplicationControllerSpec
Copy link

Expand

Name	Description	Required	Schema
replicas	number of replicas desired; defaults to 1; see http://releases.k8s.io/HEAD/docs/user-guide/replication-controller.md#what-is-a-replication-controller	false	integer (int32)
selector	label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template; see http://releases.k8s.io/HEAD/docs/user-guide/labels.md#label-selectors	false	Section 2.3.161, “any”
template	object that describes the pod that will be created if insufficient replicas are detected; takes precedence over templateRef; see http://releases.k8s.io/HEAD/docs/user-guide/replication-controller.md#pod-template	false	Section 2.3.25, “v1.PodTemplateSpec”

3.3.109. v1.ContainerStateWaiting
Copy link

Expand

Name	Description	Required	Schema	Default
reason	(brief) reason the container is not yet running, such as pulling its image	false	string

3.3.110. v1.PodTemplateList
Copy link

Expand

Name	Description	Required	Schema
kind	kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.24, “v1.ListMeta”
items	list of pod templates	true	Section 3.3.68, “v1.PodTemplate” array

3.3.111. v1.LimitRangeItem
Copy link

Expand

Name	Description	Required	Schema
type	type of resource that this limit applies to	false	string
max	max usage constraints on this kind by resource name	false	Section 2.3.161, “any”
min	min usage constraints on this kind by resource name	false	Section 2.3.161, “any”
default	default values on this kind by resource name if omitted	false	Section 2.3.161, “any”

3.3.112. v1.FinalizerName
Copy link

3.3.113. v1.LimitRange
Copy link

Expand

Name	Description	Required	Schema
kind	kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.106, “v1.ObjectMeta”
spec	spec defines the limits enforced; http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status	false	Section 3.3.57, “v1.LimitRangeSpec”

3.3.114. v1.GlusterfsVolumeSource
Copy link

Expand

Name	Description	Required	Schema	Default
endpoints	gluster hosts endpoints name; see http://releases.k8s.io/HEAD/examples/glusterfs/README.md#create-a-pod	true	string
path	path to gluster volume; see http://releases.k8s.io/HEAD/examples/glusterfs/README.md#create-a-pod	true	string
readOnly	glusterfs volume to be mounted with read-only permissions; see http://releases.k8s.io/HEAD/examples/glusterfs/README.md#create-a-pod	false	boolean	false

3.3.115. v1.PersistentVolumeClaimStatus
Copy link

Expand

Name	Description	Required	Schema
phase	the current phase of the claim	false	string
accessModes	the actual access modes the volume has; see http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#access-modes-1	false	Section 3.3.27, “v1.PersistentVolumeAccessMode” array
capacity	the actual resources the volume has	false	Section 2.3.161, “any”

3.3.116. any
Copy link

Represents an untyped JSON map - see the description of the field for more info about the structure of this object.

Chapter 3. Kubernetes v1 REST API

3.1. OverviewCopy linkLink copied to clipboard!

3.1.1. Version informationCopy linkLink copied to clipboard!

3.1.2. URI schemeCopy linkLink copied to clipboard!

3.2. PathsCopy linkLink copied to clipboard!

3.2.1. create a BindingCopy linkLink copied to clipboard!

3.2.1.1. ParametersCopy linkLink copied to clipboard!

3.2.1.2. ResponsesCopy linkLink copied to clipboard!

3.2.1.3. ConsumesCopy linkLink copied to clipboard!

3.2.1.4. ProducesCopy linkLink copied to clipboard!

3.2.1.5. TagsCopy linkLink copied to clipboard!

3.2.2. list objects of kind ComponentStatusCopy linkLink copied to clipboard!

3.2.2.1. ParametersCopy linkLink copied to clipboard!

3.2.2.2. ResponsesCopy linkLink copied to clipboard!

3.2.2.3. ConsumesCopy linkLink copied to clipboard!

3.2.2.4. ProducesCopy linkLink copied to clipboard!

3.2.2.5. TagsCopy linkLink copied to clipboard!

3.2.3. list or watch objects of kind EndpointsCopy linkLink copied to clipboard!

3.2.3.1. ParametersCopy linkLink copied to clipboard!

3.2.3.2. ResponsesCopy linkLink copied to clipboard!

3.2.3.3. ConsumesCopy linkLink copied to clipboard!

3.2.3.4. ProducesCopy linkLink copied to clipboard!

3.2.3.5. TagsCopy linkLink copied to clipboard!

3.2.4. create a EndpointsCopy linkLink copied to clipboard!

3.2.4.1. ParametersCopy linkLink copied to clipboard!

3.2.4.2. ResponsesCopy linkLink copied to clipboard!

3.2.4.3. ConsumesCopy linkLink copied to clipboard!

3.2.4.4. ProducesCopy linkLink copied to clipboard!

3.2.4.5. TagsCopy linkLink copied to clipboard!

3.2.5. list or watch objects of kind EventCopy linkLink copied to clipboard!

3.2.5.1. ParametersCopy linkLink copied to clipboard!

3.2.5.2. ResponsesCopy linkLink copied to clipboard!

3.2.5.3. ConsumesCopy linkLink copied to clipboard!

3.2.5.4. ProducesCopy linkLink copied to clipboard!

3.2.5.5. TagsCopy linkLink copied to clipboard!

3.2.6. create a EventCopy linkLink copied to clipboard!

3.2.6.1. ParametersCopy linkLink copied to clipboard!

3.2.6.2. ResponsesCopy linkLink copied to clipboard!

3.2.6.3. ConsumesCopy linkLink copied to clipboard!

3.2.6.4. ProducesCopy linkLink copied to clipboard!

3.2.6.5. TagsCopy linkLink copied to clipboard!

3.2.7. list or watch objects of kind LimitRangeCopy linkLink copied to clipboard!

3.2.7.1. ParametersCopy linkLink copied to clipboard!

3.2.7.2. ResponsesCopy linkLink copied to clipboard!

3.2.7.3. ConsumesCopy linkLink copied to clipboard!

3.2.7.4. ProducesCopy linkLink copied to clipboard!

3.2.7.5. TagsCopy linkLink copied to clipboard!

3.2.8. create a LimitRangeCopy linkLink copied to clipboard!

3.2.8.1. ParametersCopy linkLink copied to clipboard!

3.2.8.2. ResponsesCopy linkLink copied to clipboard!

3.2.8.3. ConsumesCopy linkLink copied to clipboard!

3.2.8.4. ProducesCopy linkLink copied to clipboard!

3.2.8.5. TagsCopy linkLink copied to clipboard!

3.2.9. list or watch objects of kind NamespaceCopy linkLink copied to clipboard!

3.2.9.1. ParametersCopy linkLink copied to clipboard!

3.2.9.2. ResponsesCopy linkLink copied to clipboard!

3.2.9.3. ConsumesCopy linkLink copied to clipboard!

3.2.9.4. ProducesCopy linkLink copied to clipboard!

3.2.9.5. TagsCopy linkLink copied to clipboard!

3.2.10. create a NamespaceCopy linkLink copied to clipboard!

3.2.10.1. ParametersCopy linkLink copied to clipboard!

3.2.10.2. ResponsesCopy linkLink copied to clipboard!

3.2.10.3. ConsumesCopy linkLink copied to clipboard!

3.2.10.4. ProducesCopy linkLink copied to clipboard!

3.2.10.5. TagsCopy linkLink copied to clipboard!

3.2.11. create a BindingCopy linkLink copied to clipboard!

3.2.11.1. ParametersCopy linkLink copied to clipboard!

3.2.11.2. ResponsesCopy linkLink copied to clipboard!

3.2.11.3. ConsumesCopy linkLink copied to clipboard!

3.2.11.4. ProducesCopy linkLink copied to clipboard!

3.2.11.5. TagsCopy linkLink copied to clipboard!

3.2.12. list objects of kind ComponentStatusCopy linkLink copied to clipboard!

3.2.12.1. ParametersCopy linkLink copied to clipboard!

3.2.12.2. ResponsesCopy linkLink copied to clipboard!

3.2.12.3. ConsumesCopy linkLink copied to clipboard!

3.2.12.4. ProducesCopy linkLink copied to clipboard!

3.2.12.5. TagsCopy linkLink copied to clipboard!

3.2.13. read the specified ComponentStatusCopy linkLink copied to clipboard!

3.2.13.1. ParametersCopy linkLink copied to clipboard!

3.2.13.2. ResponsesCopy linkLink copied to clipboard!

3.1. Overview
Copy link

3.1.1. Version information
Copy link

3.1.2. URI scheme
Copy link

3.2. Paths
Copy link

3.2.1. create a Binding
Copy link

3.2.1.1. Parameters
Copy link

3.2.1.2. Responses
Copy link

3.2.1.3. Consumes
Copy link

3.2.1.4. Produces
Copy link

3.2.1.5. Tags
Copy link

3.2.2. list objects of kind ComponentStatus
Copy link

3.2.2.1. Parameters
Copy link

3.2.2.2. Responses
Copy link

3.2.2.3. Consumes
Copy link

3.2.2.4. Produces
Copy link

3.2.2.5. Tags
Copy link

3.2.3. list or watch objects of kind Endpoints
Copy link

3.2.3.1. Parameters
Copy link

3.2.3.2. Responses
Copy link

3.2.3.3. Consumes
Copy link

3.2.3.4. Produces
Copy link

3.2.3.5. Tags
Copy link

3.2.4. create a Endpoints
Copy link

3.2.4.1. Parameters
Copy link

3.2.4.2. Responses
Copy link

3.2.4.3. Consumes
Copy link

3.2.4.4. Produces
Copy link

3.2.4.5. Tags
Copy link

3.2.5. list or watch objects of kind Event
Copy link

3.2.5.1. Parameters
Copy link

3.2.5.2. Responses
Copy link

3.2.5.3. Consumes
Copy link

3.2.5.4. Produces
Copy link

3.2.5.5. Tags
Copy link

3.2.6. create a Event
Copy link

3.2.6.1. Parameters
Copy link

3.2.6.2. Responses
Copy link

3.2.6.3. Consumes
Copy link

3.2.6.4. Produces
Copy link

3.2.6.5. Tags
Copy link

3.2.7. list or watch objects of kind LimitRange
Copy link

3.2.7.1. Parameters
Copy link

3.2.7.2. Responses
Copy link

3.2.7.3. Consumes
Copy link

3.2.7.4. Produces
Copy link

3.2.7.5. Tags
Copy link

3.2.8. create a LimitRange
Copy link

3.2.8.1. Parameters
Copy link

3.2.8.2. Responses
Copy link

3.2.8.3. Consumes
Copy link

3.2.8.4. Produces
Copy link

3.2.8.5. Tags
Copy link

3.2.9. list or watch objects of kind Namespace
Copy link

3.2.9.1. Parameters
Copy link

3.2.9.2. Responses
Copy link

3.2.9.3. Consumes
Copy link

3.2.9.4. Produces
Copy link

3.2.9.5. Tags
Copy link

3.2.10. create a Namespace
Copy link

3.2.10.1. Parameters
Copy link

3.2.10.2. Responses
Copy link

3.2.10.3. Consumes
Copy link

3.2.10.4. Produces
Copy link

3.2.10.5. Tags
Copy link

3.2.11. create a Binding
Copy link

3.2.11.1. Parameters
Copy link

3.2.11.2. Responses
Copy link

3.2.11.3. Consumes
Copy link

3.2.11.4. Produces
Copy link

3.2.11.5. Tags
Copy link

3.2.12. list objects of kind ComponentStatus
Copy link

3.2.12.1. Parameters
Copy link

3.2.12.2. Responses
Copy link

3.2.12.3. Consumes
Copy link

3.2.12.4. Produces
Copy link

3.2.12.5. Tags
Copy link

3.2.13. read the specified ComponentStatus
Copy link

3.2.13.1. Parameters
Copy link

3.2.13.2. Responses
Copy link

3.2.13.3. Consumes
Copy link