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 |