Operations
get available resources
GET /api/v1
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
Consumes
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
read the specified ComponentStatus
GET /api/v1/componentstatuses/{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 ComponentStatus |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
list or watch objects of kind ConfigMap
GET /api/v1/configmaps
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 |
Accepted |
|
200 |
success |
|
201 |
Created |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 |
Accepted |
|
200 |
success |
|
201 |
Created |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
list or watch objects of kind ConfigMap
GET /api/v1/namespaces/{namespace}/configmaps
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
delete collection of ConfigMap
DELETE /api/v1/namespaces/{namespace}/configmaps
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
create a ConfigMap
POST /api/v1/namespaces/{namespace}/configmaps
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 |
Accepted |
|
200 |
success |
|
201 |
Created |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
read the specified ConfigMap
GET /api/v1/namespaces/{namespace}/configmaps/{name}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
pretty |
If true, then the output is pretty printed. |
false |
string |
|
QueryParameter |
export |
Should this value be exported. Export strips fields that a user can not specify. |
false |
boolean |
|
QueryParameter |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like Namespace. |
false |
boolean |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ConfigMap |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
replace the specified ConfigMap
PUT /api/v1/namespaces/{namespace}/configmaps/{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 ConfigMap |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
|
201 |
Created |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
delete a ConfigMap
DELETE /api/v1/namespaces/{namespace}/configmaps/{name}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
pretty |
If true, then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
QueryParameter |
gracePeriodSeconds |
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
false |
integer (int32) |
|
QueryParameter |
orphanDependents |
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. |
false |
boolean |
|
QueryParameter |
propagationPolicy |
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: Orphan - orphan the dependents; Background - allow the garbage collector to delete the dependents in the background; Foreground - a cascading policy that deletes all dependents in the foreground. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ConfigMap |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
partially update the specified ConfigMap
PATCH /api/v1/namespaces/{namespace}/configmaps/{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 ConfigMap |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
application/json-patch+json
-
application/merge-patch+json
-
application/strategic-merge-patch+json
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
delete collection of Endpoints
DELETE /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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
create 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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 |
Accepted |
|
200 |
success |
|
201 |
Created |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
|
QueryParameter |
export |
Should this value be exported. Export strips fields that a user can not specify. |
false |
boolean |
|
QueryParameter |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like Namespace. |
false |
boolean |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Endpoints |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
|
201 |
Created |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
delete 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 |
|||
QueryParameter |
gracePeriodSeconds |
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
false |
integer (int32) |
|
QueryParameter |
orphanDependents |
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. |
false |
boolean |
|
QueryParameter |
propagationPolicy |
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: Orphan - orphan the dependents; Background - allow the garbage collector to delete the dependents in the background; Foreground - a cascading policy that deletes all dependents in the foreground. |
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
application/json-patch+json
-
application/merge-patch+json
-
application/strategic-merge-patch+json
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
delete collection of Event
DELETE /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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
create an 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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 |
Accepted |
|
200 |
success |
|
201 |
Created |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
|
QueryParameter |
export |
Should this value be exported. Export strips fields that a user can not specify. |
false |
boolean |
|
QueryParameter |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like Namespace. |
false |
boolean |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Event |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
delete an 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 |
|
BodyParameter |
body |
true |
|||
QueryParameter |
gracePeriodSeconds |
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
false |
integer (int32) |
|
QueryParameter |
orphanDependents |
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. |
false |
boolean |
|
QueryParameter |
propagationPolicy |
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: Orphan - orphan the dependents; Background - allow the garbage collector to delete the dependents in the background; Foreground - a cascading policy that deletes all dependents in the foreground. |
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
application/json-patch+json
-
application/merge-patch+json
-
application/strategic-merge-patch+json
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
delete collection of LimitRange
DELETE /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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 |
Accepted |
|
200 |
success |
|
201 |
Created |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
|
QueryParameter |
export |
Should this value be exported. Export strips fields that a user can not specify. |
false |
boolean |
|
QueryParameter |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like Namespace. |
false |
boolean |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the LimitRange |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
|
201 |
Created |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
|||
QueryParameter |
gracePeriodSeconds |
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
false |
integer (int32) |
|
QueryParameter |
orphanDependents |
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. |
false |
boolean |
|
QueryParameter |
propagationPolicy |
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: Orphan - orphan the dependents; Background - allow the garbage collector to delete the dependents in the background; Foreground - a cascading policy that deletes all dependents in the foreground. |
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
application/json-patch+json
-
application/merge-patch+json
-
application/strategic-merge-patch+json
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
list or watch objects of kind PersistentVolumeClaim
GET /api/v1/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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
delete collection of PersistentVolumeClaim
DELETE /api/v1/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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 |
Accepted |
|
200 |
success |
|
201 |
Created |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
|
QueryParameter |
export |
Should this value be exported. Export strips fields that a user can not specify. |
false |
boolean |
|
QueryParameter |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like Namespace. |
false |
boolean |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the PersistentVolumeClaim |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
|
201 |
Created |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
|||
QueryParameter |
gracePeriodSeconds |
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
false |
integer (int32) |
|
QueryParameter |
orphanDependents |
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. |
false |
boolean |
|
QueryParameter |
propagationPolicy |
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: Orphan - orphan the dependents; Background - allow the garbage collector to delete the dependents in the background; Foreground - a cascading policy that deletes all dependents in the foreground. |
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
application/json-patch+json
-
application/merge-patch+json
-
application/strategic-merge-patch+json
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
read status of the specified PersistentVolumeClaim
GET /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 |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the PersistentVolumeClaim |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
|
201 |
Created |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
partially update status of the specified PersistentVolumeClaim
PATCH /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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
application/json-patch+json
-
application/merge-patch+json
-
application/strategic-merge-patch+json
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
delete collection of Pod
DELETE /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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
|
QueryParameter |
export |
Should this value be exported. Export strips fields that a user can not specify. |
false |
boolean |
|
QueryParameter |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like Namespace. |
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
|||
QueryParameter |
gracePeriodSeconds |
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
false |
integer (int32) |
|
QueryParameter |
orphanDependents |
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. |
false |
boolean |
|
QueryParameter |
propagationPolicy |
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: Orphan - orphan the dependents; Background - allow the garbage collector to delete the dependents in the background; Foreground - a cascading policy that deletes all dependents in the foreground. |
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
application/json-patch+json
-
application/merge-patch+json
-
application/strategic-merge-patch+json
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
connect GET requests to attach of Pod
GET /api/v1/namespaces/{namespace}/pods/{name}/attach
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
stdin |
Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false. |
false |
boolean |
|
QueryParameter |
stdout |
Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true. |
false |
boolean |
|
QueryParameter |
stderr |
Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true. |
false |
boolean |
|
QueryParameter |
tty |
TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false. |
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
connect POST requests to attach of Pod
POST /api/v1/namespaces/{namespace}/pods/{name}/attach
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
stdin |
Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false. |
false |
boolean |
|
QueryParameter |
stdout |
Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true. |
false |
boolean |
|
QueryParameter |
stderr |
Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true. |
false |
boolean |
|
QueryParameter |
tty |
TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false. |
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
create binding of a Pod
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 |
Accepted |
|
200 |
success |
|
201 |
Created |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
create eviction of a Pod
POST /api/v1/namespaces/{namespace}/pods/{name}/eviction
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 Eviction |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 |
Accepted |
|
200 |
success |
|
201 |
Created |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
TTY if true indicates that a tty will be allocated for the exec call. Defaults to false. |
false |
boolean |
|
QueryParameter |
container |
Container in which to execute the command. Defaults to only container if there is only one container in the pod. |
false |
string |
|
QueryParameter |
command |
Command is the remote command to execute. argv array. Not executed within a shell. |
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
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 |
TTY if true indicates that a tty will be allocated for the exec call. Defaults to false. |
false |
boolean |
|
QueryParameter |
container |
Container in which to execute the command. Defaults to only container if there is only one container in the pod. |
false |
string |
|
QueryParameter |
command |
Command is the remote command to execute. argv array. Not executed within a shell. |
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
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 |
|
QueryParameter |
sinceSeconds |
A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified. |
false |
integer (int32) |
|
QueryParameter |
timestamps |
If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false. |
false |
boolean |
|
QueryParameter |
tailLines |
If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime |
false |
integer (int32) |
|
QueryParameter |
limitBytes |
If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit. |
false |
integer (int32) |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Pod |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
string |
Consumes
-
/
Produces
-
text/plain
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
connect GET requests to portforward of Pod
GET /api/v1/namespaces/{namespace}/pods/{name}/portforward
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
ports |
List of ports to forward Required when using WebSockets |
false |
integer (int32) |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Pod |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
connect POST requests to portforward of Pod
POST /api/v1/namespaces/{namespace}/pods/{name}/portforward
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
ports |
List of ports to forward Required when using WebSockets |
false |
integer (int32) |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Pod |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
connect GET requests to proxy of Pod
GET /api/v1/namespaces/{namespace}/pods/{name}/proxy
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
path |
Path is the URL path to use for the current 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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
connect PUT requests to proxy of Pod
PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
path |
Path is the URL path to use for the current 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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
connect DELETE requests to proxy of Pod
DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
path |
Path is the URL path to use for the current 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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
connect POST requests to proxy of Pod
POST /api/v1/namespaces/{namespace}/pods/{name}/proxy
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
path |
Path is the URL path to use for the current 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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
connect PATCH requests to proxy of Pod
PATCH /api/v1/namespaces/{namespace}/pods/{name}/proxy
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
path |
Path is the URL path to use for the current 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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
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 |
Path is the URL path to use for the current 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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
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 |
Path is the URL path to use for the current 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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
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 |
Path is the URL path to use for the current 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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
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 |
Path is the URL path to use for the current 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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
connect PATCH requests to proxy of Pod
PATCH /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
path |
Path is the URL path to use for the current 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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
read status of the specified Pod
GET /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 |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Pod |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
partially update status of the specified Pod
PATCH /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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
application/json-patch+json
-
application/merge-patch+json
-
application/strategic-merge-patch+json
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
delete collection of PodTemplate
DELETE /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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 |
Accepted |
|
200 |
success |
|
201 |
Created |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
|
QueryParameter |
export |
Should this value be exported. Export strips fields that a user can not specify. |
false |
boolean |
|
QueryParameter |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like Namespace. |
false |
boolean |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the PodTemplate |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
|
201 |
Created |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
|||
QueryParameter |
gracePeriodSeconds |
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
false |
integer (int32) |
|
QueryParameter |
orphanDependents |
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. |
false |
boolean |
|
QueryParameter |
propagationPolicy |
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: Orphan - orphan the dependents; Background - allow the garbage collector to delete the dependents in the background; Foreground - a cascading policy that deletes all dependents in the foreground. |
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
application/json-patch+json
-
application/merge-patch+json
-
application/strategic-merge-patch+json
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
delete collection of ReplicationController
DELETE /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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 |
Accepted |
|
200 |
success |
|
201 |
Created |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
|
QueryParameter |
export |
Should this value be exported. Export strips fields that a user can not specify. |
false |
boolean |
|
QueryParameter |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like Namespace. |
false |
boolean |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ReplicationController |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
|
201 |
Created |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
|||
QueryParameter |
gracePeriodSeconds |
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
false |
integer (int32) |
|
QueryParameter |
orphanDependents |
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. |
false |
boolean |
|
QueryParameter |
propagationPolicy |
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: Orphan - orphan the dependents; Background - allow the garbage collector to delete the dependents in the background; Foreground - a cascading policy that deletes all dependents in the foreground. |
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
application/json-patch+json
-
application/merge-patch+json
-
application/strategic-merge-patch+json
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
read scale of the specified ReplicationController
GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
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 Scale |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
replace scale of the specified ReplicationController
PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
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 Scale |
true |
string |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
partially update scale of the specified ReplicationController
PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
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 Scale |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
application/json-patch+json
-
application/merge-patch+json
-
application/strategic-merge-patch+json
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
read status of the specified ReplicationController
GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
replace status of the specified ReplicationController
PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{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 ReplicationController |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
|
201 |
Created |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
partially update status of the specified ReplicationController
PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{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 ReplicationController |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
application/json-patch+json
-
application/merge-patch+json
-
application/strategic-merge-patch+json
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
delete collection of ResourceQuota
DELETE /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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 |
Accepted |
|
200 |
success |
|
201 |
Created |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
|
QueryParameter |
export |
Should this value be exported. Export strips fields that a user can not specify. |
false |
boolean |
|
QueryParameter |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like Namespace. |
false |
boolean |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ResourceQuota |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
|
201 |
Created |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
|||
QueryParameter |
gracePeriodSeconds |
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
false |
integer (int32) |
|
QueryParameter |
orphanDependents |
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. |
false |
boolean |
|
QueryParameter |
propagationPolicy |
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: Orphan - orphan the dependents; Background - allow the garbage collector to delete the dependents in the background; Foreground - a cascading policy that deletes all dependents in the foreground. |
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
application/json-patch+json
-
application/merge-patch+json
-
application/strategic-merge-patch+json
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
read status of the specified ResourceQuota
GET /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 |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ResourceQuota |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
|
201 |
Created |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
partially update status of the specified ResourceQuota
PATCH /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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
application/json-patch+json
-
application/merge-patch+json
-
application/strategic-merge-patch+json
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
delete collection of Secret
DELETE /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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 |
Accepted |
|
200 |
success |
|
201 |
Created |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
|
QueryParameter |
export |
Should this value be exported. Export strips fields that a user can not specify. |
false |
boolean |
|
QueryParameter |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like Namespace. |
false |
boolean |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Secret |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
|||
QueryParameter |
gracePeriodSeconds |
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
false |
integer (int32) |
|
QueryParameter |
orphanDependents |
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. |
false |
boolean |
|
QueryParameter |
propagationPolicy |
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: Orphan - orphan the dependents; Background - allow the garbage collector to delete the dependents in the background; Foreground - a cascading policy that deletes all dependents in the foreground. |
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
application/json-patch+json
-
application/merge-patch+json
-
application/strategic-merge-patch+json
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
delete collection of ServiceAccount
DELETE /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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 |
Accepted |
|
200 |
success |
|
201 |
Created |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
|
QueryParameter |
export |
Should this value be exported. Export strips fields that a user can not specify. |
false |
boolean |
|
QueryParameter |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like Namespace. |
false |
boolean |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ServiceAccount |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
|
201 |
Created |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
|||
QueryParameter |
gracePeriodSeconds |
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
false |
integer (int32) |
|
QueryParameter |
orphanDependents |
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. |
false |
boolean |
|
QueryParameter |
propagationPolicy |
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: Orphan - orphan the dependents; Background - allow the garbage collector to delete the dependents in the background; Foreground - a cascading policy that deletes all dependents in the foreground. |
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
application/json-patch+json
-
application/merge-patch+json
-
application/strategic-merge-patch+json
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 |
Accepted |
|
200 |
success |
|
201 |
Created |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
|
QueryParameter |
export |
Should this value be exported. Export strips fields that a user can not specify. |
false |
boolean |
|
QueryParameter |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like Namespace. |
false |
boolean |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Service |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
|
201 |
Created |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
application/json-patch+json
-
application/merge-patch+json
-
application/strategic-merge-patch+json
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
connect GET requests to proxy of Service
GET /api/v1/namespaces/{namespace}/services/{name}/proxy
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
path |
Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
connect PUT requests to proxy of Service
PUT /api/v1/namespaces/{namespace}/services/{name}/proxy
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
path |
Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
connect DELETE requests to proxy of Service
DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
path |
Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
connect POST requests to proxy of Service
POST /api/v1/namespaces/{namespace}/services/{name}/proxy
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
path |
Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
connect PATCH requests to proxy of Service
PATCH /api/v1/namespaces/{namespace}/services/{name}/proxy
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
path |
Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
connect GET requests to proxy of Service
GET /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
path |
Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
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 |
|
PathParameter |
path |
path to the resource |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
connect PUT requests to proxy of Service
PUT /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
path |
Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
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 |
|
PathParameter |
path |
path to the resource |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
connect DELETE requests to proxy of Service
DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
path |
Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
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 |
|
PathParameter |
path |
path to the resource |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
connect POST requests to proxy of Service
POST /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
path |
Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
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 |
|
PathParameter |
path |
path to the resource |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
connect PATCH requests to proxy of Service
PATCH /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
path |
Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
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 |
|
PathParameter |
path |
path to the resource |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
read status of the specified Service
GET /api/v1/namespaces/{namespace}/services/{name}/status
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
replace status of the specified Service
PUT /api/v1/namespaces/{namespace}/services/{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 Service |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
|
201 |
Created |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
partially update status of the specified Service
PATCH /api/v1/namespaces/{namespace}/services/{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 Service |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
application/json-patch+json
-
application/merge-patch+json
-
application/strategic-merge-patch+json
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
|
QueryParameter |
export |
Should this value be exported. Export strips fields that a user can not specify. |
false |
boolean |
|
QueryParameter |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like Namespace. |
false |
boolean |
|
PathParameter |
name |
name of the Namespace |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
|
201 |
Created |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
|||
QueryParameter |
gracePeriodSeconds |
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
false |
integer (int32) |
|
QueryParameter |
orphanDependents |
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. |
false |
boolean |
|
QueryParameter |
propagationPolicy |
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: Orphan - orphan the dependents; Background - allow the garbage collector to delete the dependents in the background; Foreground - a cascading policy that deletes all dependents in the foreground. |
false |
string |
|
PathParameter |
name |
name of the Namespace |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
application/json-patch+json
-
application/merge-patch+json
-
application/strategic-merge-patch+json
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
|
201 |
Created |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
read status of the specified Namespace
GET /api/v1/namespaces/{name}/status
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
|
201 |
Created |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
partially update status of the specified Namespace
PATCH /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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
application/json-patch+json
-
application/merge-patch+json
-
application/strategic-merge-patch+json
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
delete collection of Node
DELETE /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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
|
QueryParameter |
export |
Should this value be exported. Export strips fields that a user can not specify. |
false |
boolean |
|
QueryParameter |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like Namespace. |
false |
boolean |
|
PathParameter |
name |
name of the Node |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
|||
QueryParameter |
gracePeriodSeconds |
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
false |
integer (int32) |
|
QueryParameter |
orphanDependents |
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. |
false |
boolean |
|
QueryParameter |
propagationPolicy |
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: Orphan - orphan the dependents; Background - allow the garbage collector to delete the dependents in the background; Foreground - a cascading policy that deletes all dependents in the foreground. |
false |
string |
|
PathParameter |
name |
name of the Node |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
application/json-patch+json
-
application/merge-patch+json
-
application/strategic-merge-patch+json
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
connect GET requests to proxy of Node
GET /api/v1/nodes/{name}/proxy
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
path |
Path is the URL path to use for the current proxy request to node. |
false |
string |
|
PathParameter |
name |
name of the Node |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
connect PUT requests to proxy of Node
PUT /api/v1/nodes/{name}/proxy
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
path |
Path is the URL path to use for the current proxy request to node. |
false |
string |
|
PathParameter |
name |
name of the Node |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
connect DELETE requests to proxy of Node
DELETE /api/v1/nodes/{name}/proxy
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
path |
Path is the URL path to use for the current proxy request to node. |
false |
string |
|
PathParameter |
name |
name of the Node |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
connect POST requests to proxy of Node
POST /api/v1/nodes/{name}/proxy
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
path |
Path is the URL path to use for the current proxy request to node. |
false |
string |
|
PathParameter |
name |
name of the Node |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
connect PATCH requests to proxy of Node
PATCH /api/v1/nodes/{name}/proxy
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
path |
Path is the URL path to use for the current proxy request to node. |
false |
string |
|
PathParameter |
name |
name of the Node |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
connect GET requests to proxy of Node
GET /api/v1/nodes/{name}/proxy/{path}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
path |
Path is the URL path to use for the current proxy request to node. |
false |
string |
|
PathParameter |
name |
name of the Node |
true |
string |
|
PathParameter |
path |
path to the resource |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
connect PUT requests to proxy of Node
PUT /api/v1/nodes/{name}/proxy/{path}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
path |
Path is the URL path to use for the current proxy request to node. |
false |
string |
|
PathParameter |
name |
name of the Node |
true |
string |
|
PathParameter |
path |
path to the resource |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
connect DELETE requests to proxy of Node
DELETE /api/v1/nodes/{name}/proxy/{path}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
path |
Path is the URL path to use for the current proxy request to node. |
false |
string |
|
PathParameter |
name |
name of the Node |
true |
string |
|
PathParameter |
path |
path to the resource |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
connect POST requests to proxy of Node
POST /api/v1/nodes/{name}/proxy/{path}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
path |
Path is the URL path to use for the current proxy request to node. |
false |
string |
|
PathParameter |
name |
name of the Node |
true |
string |
|
PathParameter |
path |
path to the resource |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
connect PATCH requests to proxy of Node
PATCH /api/v1/nodes/{name}/proxy/{path}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
path |
Path is the URL path to use for the current proxy request to node. |
false |
string |
|
PathParameter |
name |
name of the Node |
true |
string |
|
PathParameter |
path |
path to the resource |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
read status of the specified Node
GET /api/v1/nodes/{name}/status
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
partially update status of the specified Node
PATCH /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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
application/json-patch+json
-
application/merge-patch+json
-
application/strategic-merge-patch+json
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
list or watch objects of kind PersistentVolumeClaim
GET /api/v1/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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
delete collection of PersistentVolume
DELETE /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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 |
Accepted |
|
200 |
success |
|
201 |
Created |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
|
QueryParameter |
export |
Should this value be exported. Export strips fields that a user can not specify. |
false |
boolean |
|
QueryParameter |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like Namespace. |
false |
boolean |
|
PathParameter |
name |
name of the PersistentVolume |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
|
201 |
Created |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
|||
QueryParameter |
gracePeriodSeconds |
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
false |
integer (int32) |
|
QueryParameter |
orphanDependents |
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. |
false |
boolean |
|
QueryParameter |
propagationPolicy |
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: Orphan - orphan the dependents; Background - allow the garbage collector to delete the dependents in the background; Foreground - a cascading policy that deletes all dependents in the foreground. |
false |
string |
|
PathParameter |
name |
name of the PersistentVolume |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
application/json-patch+json
-
application/merge-patch+json
-
application/strategic-merge-patch+json
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
read status of the specified PersistentVolume
GET /api/v1/persistentvolumes/{name}/status
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
|
201 |
Created |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
partially update status of the specified PersistentVolume
PATCH /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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
application/json-patch+json
-
application/merge-patch+json
-
application/strategic-merge-patch+json
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
proxy GET requests to Pod
GET /api/v1/proxy/namespaces/{namespace}/pods/{name}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Pod |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
proxy PUT requests to Pod
PUT /api/v1/proxy/namespaces/{namespace}/pods/{name}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Pod |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
proxy DELETE requests to Pod
DELETE /api/v1/proxy/namespaces/{namespace}/pods/{name}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Pod |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
proxy POST requests to Pod
POST /api/v1/proxy/namespaces/{namespace}/pods/{name}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Pod |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
proxy PATCH requests to Pod
PATCH /api/v1/proxy/namespaces/{namespace}/pods/{name}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Pod |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
proxy GET requests to Pod
GET /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Pod |
true |
string |
|
PathParameter |
path |
path to the resource |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
proxy PUT requests to Pod
PUT /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Pod |
true |
string |
|
PathParameter |
path |
path to the resource |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
proxy DELETE requests to Pod
DELETE /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Pod |
true |
string |
|
PathParameter |
path |
path to the resource |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
proxy POST requests to Pod
POST /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Pod |
true |
string |
|
PathParameter |
path |
path to the resource |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
proxy PATCH requests to Pod
PATCH /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Pod |
true |
string |
|
PathParameter |
path |
path to the resource |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
proxy GET requests to Service
GET /api/v1/proxy/namespaces/{namespace}/services/{name}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Service |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
proxy PUT requests to Service
PUT /api/v1/proxy/namespaces/{namespace}/services/{name}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Service |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
proxy DELETE requests to Service
DELETE /api/v1/proxy/namespaces/{namespace}/services/{name}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Service |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
proxy POST requests to Service
POST /api/v1/proxy/namespaces/{namespace}/services/{name}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Service |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
proxy PATCH requests to Service
PATCH /api/v1/proxy/namespaces/{namespace}/services/{name}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Service |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
proxy GET requests to Service
GET /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Service |
true |
string |
|
PathParameter |
path |
path to the resource |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
proxy PUT requests to Service
PUT /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Service |
true |
string |
|
PathParameter |
path |
path to the resource |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
proxy DELETE requests to Service
DELETE /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Service |
true |
string |
|
PathParameter |
path |
path to the resource |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
proxy POST requests to Service
POST /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Service |
true |
string |
|
PathParameter |
path |
path to the resource |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
proxy PATCH requests to Service
PATCH /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Service |
true |
string |
|
PathParameter |
path |
path to the resource |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
proxy GET requests to Node
GET /api/v1/proxy/nodes/{name}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
name |
name of the Node |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
proxy PUT requests to Node
PUT /api/v1/proxy/nodes/{name}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
name |
name of the Node |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
proxy DELETE requests to Node
DELETE /api/v1/proxy/nodes/{name}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
name |
name of the Node |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
proxy POST requests to Node
POST /api/v1/proxy/nodes/{name}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
name |
name of the Node |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
proxy PATCH requests to Node
PATCH /api/v1/proxy/nodes/{name}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
name |
name of the Node |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
proxy GET requests to Node
GET /api/v1/proxy/nodes/{name}/{path}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
name |
name of the Node |
true |
string |
|
PathParameter |
path |
path to the resource |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
proxy PUT requests to Node
PUT /api/v1/proxy/nodes/{name}/{path}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
name |
name of the Node |
true |
string |
|
PathParameter |
path |
path to the resource |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
proxy DELETE requests to Node
DELETE /api/v1/proxy/nodes/{name}/{path}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
name |
name of the Node |
true |
string |
|
PathParameter |
path |
path to the resource |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
proxy POST requests to Node
POST /api/v1/proxy/nodes/{name}/{path}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
name |
name of the Node |
true |
string |
|
PathParameter |
path |
path to the resource |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
proxy PATCH requests to Node
PATCH /api/v1/proxy/nodes/{name}/{path}
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
name |
name of the Node |
true |
string |
|
PathParameter |
path |
path to the resource |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
success |
string |
Consumes
-
/
Produces
-
/
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
watch individual changes to a list of ConfigMap
GET /api/v1/watch/configmaps
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
watch individual changes to a list of ConfigMap
GET /api/v1/watch/namespaces/{namespace}/configmaps
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
watch changes to an object of kind ConfigMap
GET /api/v1/watch/namespaces/{namespace}/configmaps/{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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ConfigMap |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
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 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
name |
name of the Namespace |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
name |
name of the Node |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
|
PathParameter |
name |
name of the PersistentVolume |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1
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 |
includeUninitialized |
If true, partially initialized resources are included in the response. |
false |
boolean |
|
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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer (int32) |
|
QueryParameter |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
false |
integer (int32) |
|
QueryParameter |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
false |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
success |
Consumes
-
/
Produces
-
application/json
-
application/yaml
-
application/vnd.kubernetes.protobuf
-
application/json;stream=watch
-
application/vnd.kubernetes.protobuf;stream=watch
Tags
-
apiv1