POST /api/v1/bindings
×
Kubernetes v1 REST API
Paths
create a Binding
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
list objects of kind ComponentStatus
GET /api/v1/componentstatuses
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
list or watch objects of kind Endpoints
GET /api/v1/endpoints
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
create a Endpoints
POST /api/v1/endpoints
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
list or watch objects of kind Event
GET /api/v1/events
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
create a Event
POST /api/v1/events
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
list or watch objects of kind LimitRange
GET /api/v1/limitranges
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
create a LimitRange
POST /api/v1/limitranges
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
list or watch objects of kind Namespace
GET /api/v1/namespaces
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
create a Namespace
POST /api/v1/namespaces
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
create a Binding
POST /api/v1/namespaces/{namespace}/bindings
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
list objects of kind ComponentStatus
GET /api/v1/namespaces/{namespace}/componentstatuses
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
read the specified ComponentStatus
GET /api/v1/namespaces/{namespace}/componentstatuses/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 ComponentStatus |
true |
string |
list or watch objects of kind Endpoints
GET /api/v1/namespaces/{namespace}/endpoints
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
create a Endpoints
POST /api/v1/namespaces/{namespace}/endpoints
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
read the specified Endpoints
GET /api/v1/namespaces/{namespace}/endpoints/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 Endpoints |
true |
string |
replace the specified Endpoints
PUT /api/v1/namespaces/{namespace}/endpoints/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Endpoints |
true |
string |
delete a Endpoints
DELETE /api/v1/namespaces/{namespace}/endpoints/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Endpoints |
true |
string |
partially update the specified Endpoints
PATCH /api/v1/namespaces/{namespace}/endpoints/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Endpoints |
true |
string |
list or watch objects of kind Event
GET /api/v1/namespaces/{namespace}/events
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
create a Event
POST /api/v1/namespaces/{namespace}/events
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
read the specified Event
GET /api/v1/namespaces/{namespace}/events/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 Event |
true |
string |
replace the specified Event
PUT /api/v1/namespaces/{namespace}/events/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Event |
true |
string |
delete a Event
DELETE /api/v1/namespaces/{namespace}/events/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 Event |
true |
string |
partially update the specified Event
PATCH /api/v1/namespaces/{namespace}/events/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Event |
true |
string |
list or watch objects of kind LimitRange
GET /api/v1/namespaces/{namespace}/limitranges
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
create a LimitRange
POST /api/v1/namespaces/{namespace}/limitranges
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
read the specified LimitRange
GET /api/v1/namespaces/{namespace}/limitranges/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 LimitRange |
true |
string |
replace the specified LimitRange
PUT /api/v1/namespaces/{namespace}/limitranges/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the LimitRange |
true |
string |
delete a LimitRange
DELETE /api/v1/namespaces/{namespace}/limitranges/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the LimitRange |
true |
string |
partially update the specified LimitRange
PATCH /api/v1/namespaces/{namespace}/limitranges/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the LimitRange |
true |
string |
list or watch objects of kind PersistentVolumeClaim
GET /api/v1/namespaces/{namespace}/persistentvolumeclaims
Description
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.
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
create a PersistentVolumeClaim
POST /api/v1/namespaces/{namespace}/persistentvolumeclaims
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
read the specified PersistentVolumeClaim
GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
replace the specified PersistentVolumeClaim
PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the PersistentVolumeClaim |
true |
string |
delete a PersistentVolumeClaim
DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the PersistentVolumeClaim |
true |
string |
partially update the specified PersistentVolumeClaim
PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the PersistentVolumeClaim |
true |
string |
replace status of the specified PersistentVolumeClaim
PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the PersistentVolumeClaim |
true |
string |
list or watch objects of kind Pod
GET /api/v1/namespaces/{namespace}/pods
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
create a Pod
POST /api/v1/namespaces/{namespace}/pods
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
read the specified Pod
GET /api/v1/namespaces/{namespace}/pods/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
replace the specified Pod
PUT /api/v1/namespaces/{namespace}/pods/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Pod |
true |
string |
delete a Pod
DELETE /api/v1/namespaces/{namespace}/pods/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Pod |
true |
string |
partially update the specified Pod
PATCH /api/v1/namespaces/{namespace}/pods/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Pod |
true |
string |
connect GET requests to attach of Pod
GET /api/v1/namespaces/{namespace}/pods/{name}/attach
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
connect POST requests to attach of Pod
POST /api/v1/namespaces/{namespace}/pods/{name}/attach
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
create binding of a Binding
POST /api/v1/namespaces/{namespace}/pods/{name}/binding
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Binding |
true |
string |
connect GET requests to exec of Pod
GET /api/v1/namespaces/{namespace}/pods/{name}/exec
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
connect POST requests to exec of Pod
POST /api/v1/namespaces/{namespace}/pods/{name}/exec
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
read log of the specified Pod
GET /api/v1/namespaces/{namespace}/pods/{name}/log
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
connect GET requests to portforward of Pod
GET /api/v1/namespaces/{namespace}/pods/{name}/portforward
connect POST requests to portforward of Pod
POST /api/v1/namespaces/{namespace}/pods/{name}/portforward
connect GET requests to proxy of Pod
GET /api/v1/namespaces/{namespace}/pods/{name}/proxy
connect PUT requests to proxy of Pod
PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy
connect DELETE requests to proxy of Pod
DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy
connect POST requests to proxy of Pod
POST /api/v1/namespaces/{namespace}/pods/{name}/proxy
connect GET requests to proxy of Pod
GET /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path:*}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
connect PUT requests to proxy of Pod
PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path:*}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
connect DELETE requests to proxy of Pod
DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path:*}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
connect POST requests to proxy of Pod
POST /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path:*}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
replace status of the specified Pod
PUT /api/v1/namespaces/{namespace}/pods/{name}/status
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Pod |
true |
string |
list or watch objects of kind PodTemplate
GET /api/v1/namespaces/{namespace}/podtemplates
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
create a PodTemplate
POST /api/v1/namespaces/{namespace}/podtemplates
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
read the specified PodTemplate
GET /api/v1/namespaces/{namespace}/podtemplates/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
replace the specified PodTemplate
PUT /api/v1/namespaces/{namespace}/podtemplates/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the PodTemplate |
true |
string |
delete a PodTemplate
DELETE /api/v1/namespaces/{namespace}/podtemplates/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the PodTemplate |
true |
string |
partially update the specified PodTemplate
PATCH /api/v1/namespaces/{namespace}/podtemplates/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the PodTemplate |
true |
string |
list or watch objects of kind ReplicationController
GET /api/v1/namespaces/{namespace}/replicationcontrollers
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
create a ReplicationController
POST /api/v1/namespaces/{namespace}/replicationcontrollers
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
read the specified ReplicationController
GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
replace the specified ReplicationController
PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ReplicationController |
true |
string |
delete a ReplicationController
DELETE /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ReplicationController |
true |
string |
partially update the specified ReplicationController
PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ReplicationController |
true |
string |
list or watch objects of kind ResourceQuota
GET /api/v1/namespaces/{namespace}/resourcequotas
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
create a ResourceQuota
POST /api/v1/namespaces/{namespace}/resourcequotas
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
read the specified ResourceQuota
GET /api/v1/namespaces/{namespace}/resourcequotas/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
replace the specified ResourceQuota
PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ResourceQuota |
true |
string |
delete a ResourceQuota
DELETE /api/v1/namespaces/{namespace}/resourcequotas/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ResourceQuota |
true |
string |
partially update the specified ResourceQuota
PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ResourceQuota |
true |
string |
replace status of the specified ResourceQuota
PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ResourceQuota |
true |
string |
list or watch objects of kind Secret
GET /api/v1/namespaces/{namespace}/secrets
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
create a Secret
POST /api/v1/namespaces/{namespace}/secrets
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
read the specified Secret
GET /api/v1/namespaces/{namespace}/secrets/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
replace the specified Secret
PUT /api/v1/namespaces/{namespace}/secrets/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Secret |
true |
string |
delete a Secret
DELETE /api/v1/namespaces/{namespace}/secrets/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Secret |
true |
string |
partially update the specified Secret
PATCH /api/v1/namespaces/{namespace}/secrets/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Secret |
true |
string |
list or watch objects of kind ServiceAccount
GET /api/v1/namespaces/{namespace}/serviceaccounts
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
create a ServiceAccount
POST /api/v1/namespaces/{namespace}/serviceaccounts
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
read the specified ServiceAccount
GET /api/v1/namespaces/{namespace}/serviceaccounts/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
replace the specified ServiceAccount
PUT /api/v1/namespaces/{namespace}/serviceaccounts/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ServiceAccount |
true |
string |
delete a ServiceAccount
DELETE /api/v1/namespaces/{namespace}/serviceaccounts/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ServiceAccount |
true |
string |
partially update the specified ServiceAccount
PATCH /api/v1/namespaces/{namespace}/serviceaccounts/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ServiceAccount |
true |
string |
list or watch objects of kind Service
GET /api/v1/namespaces/{namespace}/services
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
create a Service
POST /api/v1/namespaces/{namespace}/services
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
read the specified Service
GET /api/v1/namespaces/{namespace}/services/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
replace the specified Service
PUT /api/v1/namespaces/{namespace}/services/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Service |
true |
string |
delete a Service
DELETE /api/v1/namespaces/{namespace}/services/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
partially update the specified Service
PATCH /api/v1/namespaces/{namespace}/services/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Service |
true |
string |
read the specified Namespace
GET /api/v1/namespaces/{name}
Parameters
| 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 |
replace the specified Namespace
PUT /api/v1/namespaces/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
name |
name of the Namespace |
true |
string |
delete a Namespace
DELETE /api/v1/namespaces/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
name |
name of the Namespace |
true |
string |
partially update the specified Namespace
PATCH /api/v1/namespaces/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
name |
name of the Namespace |
true |
string |
replace finalize of the specified Namespace
PUT /api/v1/namespaces/{name}/finalize
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
name |
name of the Namespace |
true |
string |
replace status of the specified Namespace
PUT /api/v1/namespaces/{name}/status
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
name |
name of the Namespace |
true |
string |
list or watch objects of kind Node
GET /api/v1/nodes
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
create a Node
POST /api/v1/nodes
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
read the specified Node
GET /api/v1/nodes/{name}
Parameters
| 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 |
replace the specified Node
PUT /api/v1/nodes/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
name |
name of the Node |
true |
string |
delete a Node
DELETE /api/v1/nodes/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
name |
name of the Node |
true |
string |
partially update the specified Node
PATCH /api/v1/nodes/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
name |
name of the Node |
true |
string |
replace status of the specified Node
PUT /api/v1/nodes/{name}/status
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
name |
name of the Node |
true |
string |
list or watch objects of kind PersistentVolumeClaim
GET /api/v1/persistentvolumeclaims
Description
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.
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
create a PersistentVolumeClaim
POST /api/v1/persistentvolumeclaims
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
list or watch objects of kind PersistentVolume
GET /api/v1/persistentvolumes
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
create a PersistentVolume
POST /api/v1/persistentvolumes
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
read the specified PersistentVolume
GET /api/v1/persistentvolumes/{name}
Parameters
| 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 |
replace the specified PersistentVolume
PUT /api/v1/persistentvolumes/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
name |
name of the PersistentVolume |
true |
string |
delete a PersistentVolume
DELETE /api/v1/persistentvolumes/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
name |
name of the PersistentVolume |
true |
string |
partially update the specified PersistentVolume
PATCH /api/v1/persistentvolumes/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
name |
name of the PersistentVolume |
true |
string |
replace status of the specified PersistentVolume
PUT /api/v1/persistentvolumes/{name}/status
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
name |
name of the PersistentVolume |
true |
string |
list or watch objects of kind Pod
GET /api/v1/pods
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
create a Pod
POST /api/v1/pods
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
list or watch objects of kind PodTemplate
GET /api/v1/podtemplates
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
create a PodTemplate
POST /api/v1/podtemplates
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
proxy GET requests to Pod
GET /api/v1/proxy/namespaces/{namespace}/pods/{name}
proxy PUT requests to Pod
PUT /api/v1/proxy/namespaces/{namespace}/pods/{name}
proxy DELETE requests to Pod
DELETE /api/v1/proxy/namespaces/{namespace}/pods/{name}
proxy POST requests to Pod
POST /api/v1/proxy/namespaces/{namespace}/pods/{name}
proxy GET requests to Pod
GET /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path:*}
proxy PUT requests to Pod
PUT /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path:*}
proxy DELETE requests to Pod
DELETE /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path:*}
proxy POST requests to Pod
POST /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path:*}
proxy GET requests to Service
GET /api/v1/proxy/namespaces/{namespace}/services/{name}
proxy PUT requests to Service
PUT /api/v1/proxy/namespaces/{namespace}/services/{name}
proxy DELETE requests to Service
DELETE /api/v1/proxy/namespaces/{namespace}/services/{name}
proxy POST requests to Service
POST /api/v1/proxy/namespaces/{namespace}/services/{name}
proxy GET requests to Service
GET /api/v1/proxy/namespaces/{namespace}/services/{name}/{path:*}
proxy PUT requests to Service
PUT /api/v1/proxy/namespaces/{namespace}/services/{name}/{path:*}
proxy DELETE requests to Service
DELETE /api/v1/proxy/namespaces/{namespace}/services/{name}/{path:*}
proxy POST requests to Service
POST /api/v1/proxy/namespaces/{namespace}/services/{name}/{path:*}
proxy GET requests to Node
GET /api/v1/proxy/nodes/{name}
proxy PUT requests to Node
PUT /api/v1/proxy/nodes/{name}
proxy DELETE requests to Node
DELETE /api/v1/proxy/nodes/{name}
proxy POST requests to Node
POST /api/v1/proxy/nodes/{name}
proxy GET requests to Node
GET /api/v1/proxy/nodes/{name}/{path:*}
proxy PUT requests to Node
PUT /api/v1/proxy/nodes/{name}/{path:*}
proxy DELETE requests to Node
DELETE /api/v1/proxy/nodes/{name}/{path:*}
proxy POST requests to Node
POST /api/v1/proxy/nodes/{name}/{path:*}
list or watch objects of kind ReplicationController
GET /api/v1/replicationcontrollers
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
create a ReplicationController
POST /api/v1/replicationcontrollers
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
list or watch objects of kind ResourceQuota
GET /api/v1/resourcequotas
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
create a ResourceQuota
POST /api/v1/resourcequotas
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
list or watch objects of kind Secret
GET /api/v1/secrets
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
create a Secret
POST /api/v1/secrets
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
list or watch objects of kind SecurityContextConstraints
GET /api/v1/securitycontextconstraints
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
create a SecurityContextConstraints
POST /api/v1/securitycontextconstraints
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
read the specified SecurityContextConstraints
GET /api/v1/securitycontextconstraints/{name}
Parameters
| 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 |
replace the specified SecurityContextConstraints
PUT /api/v1/securitycontextconstraints/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
name |
name of the SecurityContextConstraints |
true |
string |
delete a SecurityContextConstraints
DELETE /api/v1/securitycontextconstraints/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
name |
name of the SecurityContextConstraints |
true |
string |
partially update the specified SecurityContextConstraints
PATCH /api/v1/securitycontextconstraints/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
name |
name of the SecurityContextConstraints |
true |
string |
list or watch objects of kind ServiceAccount
GET /api/v1/serviceaccounts
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
create a ServiceAccount
POST /api/v1/serviceaccounts
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
list or watch objects of kind Service
GET /api/v1/services
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
create a Service
POST /api/v1/services
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
watch individual changes to a list of Endpoints
GET /api/v1/watch/endpoints
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch individual changes to a list of Event
GET /api/v1/watch/events
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch individual changes to a list of LimitRange
GET /api/v1/watch/limitranges
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch individual changes to a list of Namespace
GET /api/v1/watch/namespaces
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch individual changes to a list of Endpoints
GET /api/v1/watch/namespaces/{namespace}/endpoints
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch changes to an object of kind Endpoints
GET /api/v1/watch/namespaces/{namespace}/endpoints/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch individual changes to a list of Event
GET /api/v1/watch/namespaces/{namespace}/events
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch changes to an object of kind Event
GET /api/v1/watch/namespaces/{namespace}/events/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch individual changes to a list of LimitRange
GET /api/v1/watch/namespaces/{namespace}/limitranges
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch changes to an object of kind LimitRange
GET /api/v1/watch/namespaces/{namespace}/limitranges/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch individual changes to a list of PersistentVolumeClaim
GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch changes to an object of kind PersistentVolumeClaim
GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch individual changes to a list of Pod
GET /api/v1/watch/namespaces/{namespace}/pods
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch changes to an object of kind Pod
GET /api/v1/watch/namespaces/{namespace}/pods/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch individual changes to a list of PodTemplate
GET /api/v1/watch/namespaces/{namespace}/podtemplates
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch changes to an object of kind PodTemplate
GET /api/v1/watch/namespaces/{namespace}/podtemplates/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch individual changes to a list of ReplicationController
GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch changes to an object of kind ReplicationController
GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch individual changes to a list of ResourceQuota
GET /api/v1/watch/namespaces/{namespace}/resourcequotas
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch changes to an object of kind ResourceQuota
GET /api/v1/watch/namespaces/{namespace}/resourcequotas/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch individual changes to a list of Secret
GET /api/v1/watch/namespaces/{namespace}/secrets
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch changes to an object of kind Secret
GET /api/v1/watch/namespaces/{namespace}/secrets/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch individual changes to a list of ServiceAccount
GET /api/v1/watch/namespaces/{namespace}/serviceaccounts
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch changes to an object of kind ServiceAccount
GET /api/v1/watch/namespaces/{namespace}/serviceaccounts/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch individual changes to a list of Service
GET /api/v1/watch/namespaces/{namespace}/services
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch changes to an object of kind Service
GET /api/v1/watch/namespaces/{namespace}/services/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch changes to an object of kind Namespace
GET /api/v1/watch/namespaces/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch individual changes to a list of Node
GET /api/v1/watch/nodes
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch changes to an object of kind Node
GET /api/v1/watch/nodes/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch individual changes to a list of PersistentVolumeClaim
GET /api/v1/watch/persistentvolumeclaims
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch individual changes to a list of PersistentVolume
GET /api/v1/watch/persistentvolumes
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch changes to an object of kind PersistentVolume
GET /api/v1/watch/persistentvolumes/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch individual changes to a list of Pod
GET /api/v1/watch/pods
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch individual changes to a list of PodTemplate
GET /api/v1/watch/podtemplates
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch individual changes to a list of ReplicationController
GET /api/v1/watch/replicationcontrollers
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch individual changes to a list of ResourceQuota
GET /api/v1/watch/resourcequotas
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch individual changes to a list of Secret
GET /api/v1/watch/secrets
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch individual changes to a list of SecurityContextConstraints
GET /api/v1/watch/securitycontextconstraints
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch changes to an object of kind SecurityContextConstraints
GET /api/v1/watch/securitycontextconstraints/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch individual changes to a list of ServiceAccount
GET /api/v1/watch/serviceaccounts
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
watch individual changes to a list of Service
GET /api/v1/watch/services
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
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 |
Definitions
v1.PersistentVolume
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.
| 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 |
standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
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 |
||
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 |
v1.MetadataVolumeSource
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
items |
list of metadata files |
false |
v1.MetadataFile array |
v1.TCPSocketAction
| 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 |
v1.ResourceQuotaStatus
| 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 |
||
used |
used is the current observed total usage of the resource in the namespace |
false |
v1.ContainerStateTerminated
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
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 |
v1.ReplicationControllerList
| 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 |
standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
items |
list of replication controllers; see http://releases.k8s.io/HEAD/docs/user-guide/replication-controller.md |
true |
v1.ReplicationController array |
v1.Pod
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.
| 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 |
standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
spec |
specification of the desired behavior of the pod; http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
||
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 |
v1.Event
| 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 |
standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
true |
||
involvedObject |
object this event is about |
true |
||
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 |
||
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) |
v1.HostPathVolumeSource
| 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 |
v1.Volume
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
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 |
||
emptyDir |
temporary directory that shares a pod’s lifetime; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#emptydir |
false |
||
gcePersistentDisk |
GCE disk resource attached to the host machine on demand; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk |
false |
||
awsElasticBlockStore |
AWS disk resource attached to the host machine on demand; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore |
false |
||
gitRepo |
git repository at a particular revision |
false |
||
secret |
secret to populate volume; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#secrets |
false |
||
nfs |
NFS volume that will be mounted in the host machine; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs |
false |
||
iscsi |
iSCSI disk attached to host machine on demand; see http://releases.k8s.io/HEAD/examples/iscsi/README.md |
false |
||
glusterfs |
Glusterfs volume that will be mounted on the host machine; see http://releases.k8s.io/HEAD/examples/glusterfs/README.md |
false |
||
persistentVolumeClaim |
a reference to a PersistentVolumeClaim in the same namespace; see http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistentvolumeclaims |
false |
||
rbd |
rados block volume that will be mounted on the host machine; see http://releases.k8s.io/HEAD/examples/rbd/README.md |
false |
||
cephfs |
Ceph filesystem that will be mounted on the host machine |
false |
||
metadata |
Metadata volume containing information about the pod |
false |
v1.ContainerStateRunning
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
startedAt |
time at which the container was last (re-)started |
false |
string (date-time) |
v1.DeleteOptions
| 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 |
|
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) |
v1.ListMeta
| 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 |
v1.PodTemplateSpec
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
metadata |
standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
spec |
specification of the desired behavior of the pod; http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
v1.SecretList
| 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 |
standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
items |
items is a list of secret objects; see http://releases.k8s.io/HEAD/docs/user-guide/secrets.md |
true |
v1.Secret array |
v1.NFSVolumeSource
| 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 |
v1.CephFSVolumeSource
| 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 |
||
readOnly |
Ceph fs to be mounted with read-only permissions |
false |
boolean |
false |
v1.Capabilities
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
add |
added capabilities |
false |
v1.Capability array |
|
drop |
dropped capabilities |
false |
v1.Capability array |
v1.ComponentCondition
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
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 |
v1.ServiceStatus
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
loadBalancer |
status of load-balancer |
false |
v1.SecretVolumeSource
| 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 |
v1.ResourceRequirements
| 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 |
||
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 |
v1.PersistentVolumeClaim
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.
| 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 |
standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
spec |
the desired characteristics of a volume; see http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistentvolumeclaims |
false |
||
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 |
v1.SecurityContextConstraintsList
| 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 |
|||
items |
true |
v1.NamespaceStatus
| 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 |
v1.ResourceQuotaSpec
| 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 |
v1.RunAsUserStrategyOptions
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
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) |
v1.PersistentVolumeSpec
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
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 |
||
gcePersistentDisk |
GCE disk resource provisioned by an admin; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk |
false |
||
awsElasticBlockStore |
AWS disk resource provisioned by an admin; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore |
false |
||
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 |
||
glusterfs |
Glusterfs volume resource provisioned by an admin; see http://releases.k8s.io/HEAD/examples/glusterfs/README.md |
false |
||
nfs |
NFS volume resource provisioned by an admin; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs |
false |
||
rbd |
rados block volume that will be mounted on the host machine; see http://releases.k8s.io/HEAD/examples/rbd/README.md |
false |
||
iscsi |
an iSCSI disk resource provisioned by an admin |
false |
||
cephfs |
Ceph filesystem that will be mounted on the host machine |
false |
||
accessModes |
all ways the volume can be mounted; see http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#access-modes |
false |
||
claimRef |
when bound, a reference to the bound claim; see http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#binding |
false |
||
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 |
v1.ExecAction
| 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 |
v1.PersistentVolumeClaimVolumeSource
| 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 |
v1.ServiceSpec
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
ports |
ports exposed by the service; see http://releases.k8s.io/HEAD/docs/user-guide/services.md#virtual-ips-and-service-proxies |
true |
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 |
||
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 |
v1.ServiceList
| 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 |
standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
items |
list of services |
true |
v1.Service array |
v1.PersistentVolumeList
| 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 |
standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
||
items |
list of persistent volumes; see http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md |
false |
v1.PersistentVolume array |
v1.ContainerStatus
| 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 |
||
lastState |
details about the container’s last termination condition |
false |
||
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 |
v1.Handler
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
exec |
exec-based handler |
false |
||
httpGet |
HTTP-based handler |
false |
||
tcpSocket |
TCP-based handler; TCP hooks not yet supported |
false |
v1.NodeAddress
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
type |
node address type, one of Hostname, ExternalIP or InternalIP |
true |
string |
|
address |
the node address |
true |
string |
v1.EndpointPort
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
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 |
v1.EndpointSubset
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
addresses |
IP addresses which offer the related ports |
false |
v1.EndpointAddress array |
|
ports |
port numbers available on the related IP addresses |
false |
v1.EndpointPort array |
v1.LimitRangeList
| 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 |
standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
items |
items is a list of LimitRange objects; see http://releases.k8s.io/HEAD/docs/design/admission_control_limit_range.md |
true |
v1.LimitRange array |
v1.Container
| 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 |
v1.ContainerPort array |
|
env |
list of environment variables to set in the container; cannot be updated |
false |
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 |
||
volumeMounts |
pod volumes to mount into the container’s filesystem; cannot be updated |
false |
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 |
||
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 |
||
lifecycle |
actions that the management system should take in response to container lifecycle events; cannot be updated |
false |
||
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 |
||
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 |
v1.MetadataFile
| 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 |
v1.PodSpec
| 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 |
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 |
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 |
||
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 |
v1.LocalObjectReference array |
v1.PersistentVolumeStatus
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
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 |
v1.RBDVolumeSource
| 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 |
||
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 |
v1.LoadBalancerIngress
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
ip |
IP address of ingress point |
false |
string |
|
hostname |
hostname of ingress point |
false |
string |
v1.SecurityContext
| 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 |
||
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 |
||
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 |
v1.ServicePort
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
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) |
v1.StatusCause
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
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 |
v1.Namespace
| 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 |
standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
spec |
spec defines the behavior of the Namespace; http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
||
status |
status describes the current status of a Namespace; http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
v1.GCEPersistentDiskVolumeSource
| 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 |
v1.EndpointsList
| 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 |
standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
items |
list of endpoints |
true |
v1.Endpoints array |
v1.NodeList
| 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 |
standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
items |
list of nodes |
true |
v1.Node array |
v1.EventSource
| 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 |
v1.EnvVarSource
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
fieldRef |
selects a field of the pod; only name and namespace are supported |
true |
v1.LimitRangeSpec
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
limits |
limits is the list of LimitRangeItem objects that are enforced |
true |
v1.LimitRangeItem array |
v1.PersistentVolumeClaimSpec
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
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 |
||
resources |
the desired resources the volume should have; see http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#resources |
false |
||
volumeName |
the binding reference to the persistent volume backing this claim |
false |
string |
v1.ReplicationController
| 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 |
standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
spec |
specification of the desired behavior of the replication controller; http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
||
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 |
v1.NamespaceList
| 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 |
standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
items |
items is the list of Namespace objects in the list; see http://releases.k8s.io/HEAD/docs/user-guide/namespaces.md |
true |
v1.Namespace array |
v1.SecurityContextConstraints
| 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 |
|||
allowPrivilegedContainer |
allow containers to run as privileged |
true |
boolean |
false |
allowedCapabilities |
capabilities that are allowed to be added |
true |
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 |
||
runAsUser |
strategy used to generate RunAsUser |
false |
||
users |
users allowed to use this SecurityContextConstraints |
false |
string array |
|
groups |
groups allowed to use this SecurityContextConstraints |
false |
string array |
v1.VolumeMount
| 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 |
v1.NodeStatus
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
capacity |
compute resource capacity of the node; see http://releases.k8s.io/HEAD/docs/user-guide/compute-resources.md |
false |
||
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 |
v1.NodeCondition array |
|
addresses |
list of addresses reachable to the node; see http://releases.k8s.io/HEAD/docs/admin/node.md#node-addresses |
false |
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 |
v1.ReplicationControllerStatus
| 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) |
v1.PodCondition
| 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 |
v1.NodeCondition
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
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 |
v1.ServiceAccount
| 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 |
standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
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 |
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 |
v1.LocalObjectReference array |
v1.PodTemplate
| 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 |
standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
template |
the template of the desired behavior of the pod; http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
v1.PodList
| 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 |
standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
||
items |
list of pods; see http://releases.k8s.io/HEAD/docs/user-guide/pods.md |
true |
v1.Pod array |
v1.EmptyDirVolumeSource
| 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 |
v1.NodeSpec
| 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 |
v1.HTTPGetAction
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
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 |
v1.ResourceQuotaList
| 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 |
standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
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 |
v1.ResourceQuota array |
v1.ServiceAccountList
| 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 |
standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
items |
list of ServiceAccounts; see http://releases.k8s.io/HEAD/docs/design/service_accounts.md#service-accounts |
true |
v1.ServiceAccount array |
v1.Probe
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
exec |
exec-based handler |
false |
||
httpGet |
HTTP-based handler |
false |
||
tcpSocket |
TCP-based handler; TCP hooks not yet supported |
false |
||
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) |
v1.NamespaceSpec
| 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 |
v1.FinalizerName array |
v1.ISCSIVolumeSource
| 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 |
v1.EventList
| 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 |
standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
items |
list of events |
true |
v1.Event array |
v1.LoadBalancerStatus
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
ingress |
load-balancer ingress points |
false |
v1.LoadBalancerIngress array |
v1.PersistentVolumeClaimList
| 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 |
standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
||
items |
a list of persistent volume claims; see http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistentvolumeclaims |
false |
v1.PersistentVolumeClaim array |
v1.ComponentStatus
| 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 |
standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
conditions |
list of component conditions observed |
false |
v1.ComponentCondition array |
v1.GitRepoVolumeSource
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
repository |
repository URL |
true |
string |
|
revision |
commit hash for the specified revision |
true |
string |
v1.ObjectMeta
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
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 |
||
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 |
v1.LocalObjectReference
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
name |
name of the referent; see http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names |
false |
string |
v1.ContainerPort
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
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 |
v1.Secret
| 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 |
standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
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 |
||
type |
type facilitates programmatic handling of secret data |
false |
string |
v1.ContainerState
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
waiting |
details about a waiting container |
false |
||
running |
details about a running container |
false |
||
terminated |
details about a terminated container |
false |
v1.Endpoints
| 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 |
standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
subsets |
sets of addresses and ports that comprise a service |
true |
v1.EndpointSubset array |
v1.SELinuxContextStrategyOptions
| 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 |
v1.PodStatus
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
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 |
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 |
v1.ContainerStatus array |
v1.SELinuxOptions
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
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 |
v1.Service
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.
| 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 |
standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
spec |
specification of the desired behavior of the service; http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
||
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 |
v1.ObjectReference
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
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 |
v1.ObjectFieldSelector
| 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 |
v1.ComponentStatusList
| 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 |
standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
items |
list of component status objects |
true |
v1.ComponentStatus array |
v1.Lifecycle
| 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 |
||
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 |
v1.Status
| 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 |
standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
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 |
||
code |
suggested HTTP return code for this status; 0 if not set |
false |
integer (int32) |
v1.NodeSystemInfo
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
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 |
json.WatchEvent
| 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 |
v1.EndpointAddress
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
ip |
IP address of the endpoint |
true |
string |
|
targetRef |
reference to object providing the endpoint |
false |
v1.AWSElasticBlockStoreVolumeSource
| 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 |
v1.Binding
| 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 |
standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
target |
an object to bind to |
true |
v1.Node
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.
| 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 |
standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
spec |
specification of a node; http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
||
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 |
v1.StatusDetails
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
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 |
v1.StatusCause array |
|
retryAfterSeconds |
the number of seconds before the client should attempt to retry this operation |
false |
integer (int32) |
v1.ResourceQuota
| 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 |
standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
spec |
spec defines the desired quota; http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
||
status |
status defines the actual enforced quota and current usage; http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
v1.EnvVar
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
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 |
v1.ReplicationControllerSpec
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
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 |
||
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 |
v1.ContainerStateWaiting
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
reason |
(brief) reason the container is not yet running, such as pulling its image |
false |
string |
v1.PodTemplateList
| 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 |
standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
items |
list of pod templates |
true |
v1.PodTemplate array |
v1.LimitRangeItem
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
type |
type of resource that this limit applies to |
false |
string |
|
max |
max usage constraints on this kind by resource name |
false |
||
min |
min usage constraints on this kind by resource name |
false |
||
default |
default values on this kind by resource name if omitted |
false |
v1.LimitRange
| 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 |
standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
spec |
spec defines the limits enforced; http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
v1.GlusterfsVolumeSource
| 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 |
v1.PersistentVolumeClaimStatus
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
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 |
||
capacity |
the actual resources the volume has |
false |