curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
delete collection of DaemonSet
HTTP Request
@@ -2632,7 +2715,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -2663,23 +2746,29 @@
Read
$ kubectl get daemonset daemonset-example -o json
+
curl Command (requires kubectl proxy to be running)
-$ kubectl proxy
-$ curl -X GET http://127.0.0.1:8001/apis/apps/v1/namespaces/default/daemonsets/daemonset-example
+$ kubectl proxy
+$ curl -X GET http://127.0.0.1:8001/apis/apps/v1/namespaces/default/daemonsets/daemonset-example
+
Output
+
+
Response Body
+
+
read the specified DaemonSet
HTTP Request
@@ -2747,24 +2836,28 @@
List
Coming Soon
+
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
list or watch objects of kind DaemonSet
HTTP Request
@@ -2823,7 +2916,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -2852,24 +2945,28 @@
List All Namespaces
Coming Soon
+
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
list or watch objects of kind DaemonSet
HTTP Request
@@ -2913,7 +3010,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -2942,24 +3039,28 @@
Watch
Coming Soon
+
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
watch changes to an object of kind DaemonSet
HTTP Request
@@ -3022,7 +3123,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -3051,24 +3152,28 @@
Watch List
Coming Soon
+
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
watch individual changes to a list of DaemonSet
HTTP Request
@@ -3127,7 +3232,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -3156,24 +3261,28 @@
Watch List All Namespaces
Coming Soon
+
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
watch individual changes to a list of DaemonSet
HTTP Request
@@ -3217,7 +3326,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -3248,24 +3357,28 @@
Patch Status
Coming Soon
+
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
partially update status of the specified DaemonSet
HTTP Request
@@ -3340,24 +3453,28 @@
Read Status
Coming Soon
+
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
read status of the specified DaemonSet
HTTP Request
@@ -3417,24 +3534,28 @@
Replace Status
Coming Soon
+
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
replace status of the specified DaemonSet
HTTP Request
@@ -3532,6 +3653,8 @@
Deployment v1 apps
- name: nginx
# Run this image
image: nginx:1.10
+
+
Deployment Config to run 3 nginx instances (max rollback set to 10 revisions).
@@ -3556,6 +3679,8 @@
Deployment v1 apps
- name: nginx
# Run this image
image: nginx:1.10
+
+
@@ -3785,7 +3910,7 @@
RollingUpdateDeployment v1 apps
maxSurge
-
The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new RC can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new RC can be scaled up further, ensuring that total number of pods running at any time during the update is atmost 130% of desired pods.
+
The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new RC can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new RC can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods.
maxUnavailable
@@ -3818,6 +3943,7 @@
Create
ports:
-containerPort:80' | kubectl create -f -
+
curl Command (requires kubectl proxy to be running)
Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy. This is an alpha feature introduced in v1.9 and CustomPodDNS feature gate must be enabled to use it.
+
Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.
dnsPolicy string
-
Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'. Note that 'None' policy is an alpha feature introduced in v1.9 and CustomPodDNS feature gate must be enabled to use it.
+
Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.
hostAliases HostAlias array patch type: merge patch merge key: ip
@@ -8446,7 +8711,7 @@
PodSpec v1 core
priorityClassName string
-
If specified, indicates the pod's priority. "SYSTEM" is a special keyword which indicates the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default.
+
If specified, indicates the pod's priority. "system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default.
Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false. This field is alpha-level and is honored only by servers that enable the PodShareProcessNamespace feature.
+
+
subdomain string
If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". If not specified, the pod will not have a domainname at all.
@@ -8523,6 +8792,10 @@
PodStatus v1 core
A human readable message indicating details about why the pod is in this condition.
+
nominatedNodeName string
+
nominatedNodeName is set only when this pod preempts other pods on the node, but it cannot be scheduled right away as preemption victims receive their graceful termination periods. This field does not guarantee that the pod will be scheduled on this node. Scheduler may decide to place the pod elsewhere if other nodes become available sooner. Scheduler may also decide to give the resources on this node to a higher priority pod that is created after preemption. As a result, this field may be different than PodSpec.nodeName when the pod is scheduled.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
delete an Ingress
HTTP Request
@@ -18755,24 +18900,28 @@
Delete Collection
Coming Soon
+
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
delete collection of Ingress
HTTP Request
@@ -18831,7 +18980,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -18862,24 +19011,28 @@
Read
Coming Soon
+
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
read the specified Ingress
HTTP Request
@@ -18947,24 +19100,28 @@
List
Coming Soon
+
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
list or watch objects of kind Ingress
HTTP Request
@@ -19023,7 +19180,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -19052,24 +19209,28 @@
List All Namespaces
Coming Soon
+
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
list or watch objects of kind Ingress
HTTP Request
@@ -19113,7 +19274,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -19142,24 +19303,28 @@
Watch
Coming Soon
+
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
watch changes to an object of kind Ingress
HTTP Request
@@ -19222,7 +19387,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -19251,24 +19416,28 @@
Watch List
Coming Soon
+
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
watch individual changes to a list of Ingress
HTTP Request
@@ -19327,7 +19496,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -19356,24 +19525,28 @@
Watch List All Namespaces
Coming Soon
+
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
watch individual changes to a list of Ingress
HTTP Request
@@ -19417,7 +19590,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -19448,24 +19621,28 @@
Patch Status
Coming Soon
+
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
partially update status of the specified Ingress
HTTP Request
@@ -19540,24 +19717,28 @@
Read Status
Coming Soon
+
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
read status of the specified Ingress
HTTP Request
@@ -19617,24 +19798,28 @@
Replace Status
Coming Soon
+
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
replace status of the specified Ingress
HTTP Request
@@ -19732,6 +19917,8 @@
Service v1 core
# with an External IP address - *Only supported
# by some cloud providers*
type: LoadBalancer
+
+
Service Config to load balance traffic across all Pods with the app=nginx label. Receives on and sends to port 80. Exposes an externally accessible endpoint.
@@ -19756,6 +19943,8 @@
Service v1 core
# with an External IP address - *Only supported
# by some cloud providers*
type: LoadBalancer
+
+
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
+
+
+
orphanDependents
+
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
+
+
+
propagationPolicy
+
Whether and how garbage collection will be performed. 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.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
connect GET requests to proxy of Service
+
connect PUT requests to proxy of Service
HTTP Request
-
GET /api/v1/namespaces/{namespace}/services/{name}/proxy
+
PUT /api/v1/namespaces/{namespace}/services/{name}/proxy
Path Parameters
@@ -22133,34 +22500,38 @@
Response
-
Get Connect Proxy Path
+
Replace Connect Proxy Path
kubectl Command
Coming Soon
+
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
connect GET requests to proxy of Service
+
connect PUT requests to proxy of Service
HTTP Request
-
GET /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
+
PUT /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
Path Parameters
@@ -22214,34 +22585,132 @@
Response
-
Get Proxy
+
CONFIG & STORAGE
+
Config and Storage resources are responsible for injecting data into your applications and persisting data externally to your container.
+
Common resource types:
+
+
ConfigMaps for providing text key value pairs injected into the application through environment variables, command line arguments, or files
+
Secrets for providing binary data injected into the application through files
+
Volumes for providing a filesystem external to the Container. Maybe shared across Containers within the same Pod and have a lifetime persisting beyond a Container or Pod.
+
+
+
+
ConfigMap v1 core
+
+
+
+
Group
+
Version
+
Kind
+
+
+
+
+
Core
+
v1
+
ConfigMap
+
+
+
+
ConfigMap holds configuration data for pods to consume.
BinaryData contains the binary data. Each key must consist of alphanumeric characters, '-', '_' or '.'. BinaryData can contain byte sequences that are not in the UTF-8 range. The keys stored in BinaryData must not overlap with the ones in the Data field, this is enforced during validation process. Using this field will require 1.10+ apiserver and kubelet.
+
+
+
data object
+
Data contains the configuration data. Each key must consist of alphanumeric characters, '-', '_' or '.'. Values with non-UTF-8 byte sequences must use the BinaryData field. The keys stored in Data must not overlap with the keys in the BinaryData field, this is enforced during validation process.
object name and auth scope, such as for teams and projects
+
+
+
Query Parameters
+
+
+
+
Parameter
+
Description
+
+
+
-
path
-
path to the resource
+
pretty
+
If 'true', then the output is pretty printed.
+
+
+
gracePeriodSeconds
+
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
+
+
+
orphanDependents
+
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
+
+
+
propagationPolicy
+
Whether and how garbage collection will be performed. 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.
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
proxy PUT requests to Service
+
list or watch objects of kind ConfigMap
HTTP Request
-
PUT /api/v1/proxy/namespaces/{namespace}/services/{name}
+
GET /api/v1/namespaces/{namespace}/configmaps
Path Parameters
@@ -22696,15 +23325,58 @@
Path Parameters
-
name
-
name of the Service
-
-
namespace
object name and auth scope, such as for teams and projects
+
Query Parameters
+
+
+
+
Parameter
+
Description
+
+
+
+
+
pretty
+
If 'true', then the output is pretty printed.
+
+
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
proxy PUT requests to Service
+
list or watch objects of kind ConfigMap
HTTP Request
-
PUT /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
-
Path Parameters
+
GET /api/v1/configmaps
+
Query Parameters
@@ -22758,16 +23434,40 @@
Path Parameters
-
name
-
name of the Service
+
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.
-
namespace
-
object name and auth scope, such as for teams and projects
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
path
-
path to the resource
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
pretty
+
If 'true', then the output is pretty printed.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
+
+
+Coming Soon
+
+
+
+
Output
+
+
+Coming Soon
+
+
+
+
Response Body
+
+
+Coming Soon
+
+
+
watch changes to an object of kind ConfigMap
+
HTTP Request
+
GET /api/v1/watch/namespaces/{namespace}/configmaps/{name}
+
Path Parameters
+
+
+
+
Parameter
+
Description
+
+
+
+
+
name
+
name of the ConfigMap
+
+
+
namespace
+
object name and auth scope, such as for teams and projects
+
+
+
+
Query Parameters
+
+
+
+
Parameter
+
Description
+
+
+
+
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
pretty
+
If 'true', then the output is pretty printed.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
+
+
+Coming Soon
+
+
+
+
Output
+
+
+Coming Soon
+
+
+
+
Response Body
+
+
+Coming Soon
+
+
+
watch individual changes to a list of ConfigMap
+
HTTP Request
+
GET /api/v1/watch/namespaces/{namespace}/configmaps
+
Path Parameters
+
+
+
+
Parameter
+
Description
+
+
+
+
+
namespace
+
object name and auth scope, such as for teams and projects
+
+
+
+
Query Parameters
+
+
+
+
Parameter
+
Description
+
+
+
+
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
pretty
+
If 'true', then the output is pretty printed.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
+
+
+Coming Soon
+
+
+
+
Output
+
+
+Coming Soon
+
+
+
+
Response Body
+
+
+Coming Soon
+
+
+
watch individual changes to a list of ConfigMap
+
HTTP Request
+
GET /api/v1/watch/configmaps
+
Query Parameters
+
+
+
+
Parameter
+
Description
+
+
+
+
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
pretty
+
If 'true', then the output is pretty printed.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
Config and Storage resources are responsible for injecting data into your applications and persisting data externally to your container.
-
Common resource types:
-
-
ConfigMaps for providing text key value pairs injected into the application through environment variables, command line arguments, or files
-
Secrets for providing binary data injected into the application through files
-
Volumes for providing a filesystem external to the Container. Maybe shared across Containers within the same Pod and have a lifetime persisting beyond a Container or Pod.
-
-
-
ConfigMap v1 core
+
Secret v1 core
@@ -22809,16 +23816,16 @@
ConfigMap v1 core
Core
v1
-
ConfigMap
+
Secret
-
ConfigMap holds configuration data for pods to consume.
+
Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes.
@@ -22835,7 +23842,7 @@
ConfigMap v1 core
data object
-
Data contains the configuration data. Each key must consist of alphanumeric characters, '-', '_' or '.'.
+
Data contains the secret data. Each key must consist of alphanumeric characters, '-', '_' or '.'. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4
stringData allows specifying non-binary secret data in string form. It is provided as a write-only convenience method. All keys and values are merged into the data field on write, overwriting any existing values. It is never output when reading from the API.
+
+
+
type string
+
Used to facilitate programmatic handling of secret data.
Data contains the secret data. Each key must consist of alphanumeric characters, '-', '_' or '.'. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4
stringData allows specifying non-binary secret data in string form. It is provided as a write-only convenience method. All keys and values are merged into the data field on write, overwriting any existing values. It is never output when reading from the API.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
create a Secret
-
HTTP Request
-
POST /api/v1/namespaces/{namespace}/secrets
-
Path Parameters
-
-
-
Parameter
-
Description
+
volumeMode string
+
volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. This is an alpha feature and may change in the future.
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
+
volumeName string
+
VolumeName is the binding reference to the PersistentVolume backing this claim.
PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
Path Parameters
@@ -24367,7 +25422,7 @@
Path Parameters
name
-
name of the Secret
+
name of the PersistentVolumeClaim
namespace
@@ -24388,18 +25443,6 @@
Query Parameters
pretty
If 'true', then the output is pretty printed.
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. 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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
delete collection of Secret
-
HTTP Request
-
DELETE /api/v1/namespaces/{namespace}/secrets
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
-
-
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
+
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.
-
export
-
Should this value be exported. Export strips fields that a user can not specify.
+
orphanDependents
+
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
+
+
+
propagationPolicy
+
Whether and how garbage collection will be performed. 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.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
list or watch objects of kind Secret
+
read the specified PersistentVolumeClaim
HTTP Request
-
GET /api/v1/secrets
-
Query Parameters
+
GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
+
Path Parameters
@@ -24767,40 +25740,35 @@
Query Parameters
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
+
name
+
name of the PersistentVolumeClaim
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
namespace
+
object name and auth scope, such as for teams and projects
+
+
+
Query Parameters
+
+
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
Parameter
+
Description
+
+
pretty
If 'true', then the output is pretty printed.
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
+
exact
+
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
export
+
Should this value be exported. Export strips fields that a user can not specify.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch changes to an object of kind Secret
+
list or watch objects of kind PersistentVolumeClaim
HTTP Request
-
GET /api/v1/watch/namespaces/{namespace}/secrets/{name}
+
GET /api/v1/namespaces/{namespace}/persistentvolumeclaims
Path Parameters
@@ -24857,10 +25829,6 @@
Path Parameters
-
name
-
name of the Secret
-
-
namespace
object name and auth scope, such as for teams and projects
@@ -24876,6 +25844,10 @@
Query Parameters
+
pretty
+
If 'true', then the output is pretty printed.
+
+
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.
@@ -24896,16 +25868,12 @@
Query Parameters
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
pretty
-
If 'true', then the output is pretty printed.
-
-
resourceVersion
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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.
If true, partially initialized resources are included in the response.
-
volumeMode string
-
volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. This is an alpha feature and may change in the future.
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
volumeName string
-
VolumeName is the binding reference to the PersistentVolume backing this claim.
-
-
-
-
PersistentVolumeClaimStatus v1 core
-
-
-
-
-
-
Field
-
Description
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
Represents the actual resources of the underlying volume.
+
resourceVersion
+
When 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.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
create a PersistentVolumeClaim
+
watch individual changes to a list of PersistentVolumeClaim
HTTP Request
-
POST /api/v1/namespaces/{namespace}/persistentvolumeclaims
-
Path Parameters
+
GET /api/v1/watch/persistentvolumeclaims
+
Query Parameters
@@ -25330,38 +26254,40 @@
Path Parameters
-
namespace
-
object name and auth scope, such as for teams and projects
+
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.
-
-
-
Query Parameters
-
-
-
Parameter
-
Description
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
pretty
If 'true', then the output is pretty printed.
-
-
-
Body Parameters
-
-
-
Parameter
-
Description
+
resourceVersion
+
When 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.
PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
Path Parameters
@@ -25636,18 +26549,6 @@
Query Parameters
pretty
If 'true', then the output is pretty printed.
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. 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.
Dynamically provisioned PersistentVolumes of this storage class are created with these mountOptions, e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid.
+
+
+
parameters object
+
Parameters holds the parameters for the provisioner that should create volumes of this storage class.
+
+
+
provisioner string
+
Provisioner indicates the type of the provisioner.
+
+
+
reclaimPolicy string
+
Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. Defaults to Delete.
+
+
+
volumeBindingMode string
+
VolumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is alpha-level and is only honored by servers that enable the VolumeScheduling feature.
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.
+
Code
+
Description
+
+
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
Parameter
+
Description
+
+
-
resourceVersion
-
When 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.
+
name
+
name of the StorageClass
+
+
+
Query Parameters
+
+
-
timeoutSeconds
-
Timeout for the list/watch call.
+
Parameter
+
Description
+
+
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
object name and auth scope, such as for teams and projects
+
name
+
name of the StorageClass
@@ -25929,36 +27024,31 @@
Query Parameters
If 'true', then the output is pretty printed.
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
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.
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
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.
-
resourceVersion
-
When 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.
+
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.
+
+
+
Body Parameters
+
+
-
timeoutSeconds
-
Timeout for the list/watch call.
+
Parameter
+
Description
+
+
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
list or watch objects of kind PersistentVolumeClaim
+
delete collection of StorageClass
HTTP Request
-
GET /api/v1/persistentvolumeclaims
+
DELETE /apis/storage.k8s.io/v1/storageclasses
Query Parameters
@@ -26015,6 +27109,10 @@
Query Parameters
+
pretty
+
If 'true', then the output is pretty printed.
+
+
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.
@@ -26035,16 +27133,12 @@
Query Parameters
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
pretty
-
If 'true', then the output is pretty printed.
-
-
resourceVersion
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
curl Command (requires kubectl proxy to be running)
+
+
+Coming Soon
+
+
+
+
Output
+
+
+Coming Soon
+
+
+
+
Response Body
+
+
+Coming Soon
+
+
+
list or watch objects of kind StorageClass
+
HTTP Request
+
GET /apis/storage.k8s.io/v1/storageclasses
Query Parameters
@@ -26124,6 +27290,10 @@
Query Parameters
+
pretty
+
If 'true', then the output is pretty printed.
+
+
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.
@@ -26144,16 +27314,12 @@
Query Parameters
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
pretty
-
If 'true', then the output is pretty printed.
-
-
resourceVersion
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
Dynamically provisioned PersistentVolumes of this storage class are created with these mountOptions, e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid.
Status of the VolumeAttachment request. Populated by the entity completing the attach or detach operation, i.e. the external-attacher.
+
+
+
+
VolumeAttachmentSpec v1alpha1 storage
+
+
+
+
+
+
Field
+
Description
+
+
-
provisioner string
-
Provisioner indicates the type of the provisioner.
+
attacher string
+
Attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName().
-
reclaimPolicy string
-
Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. Defaults to Delete.
+
nodeName string
+
The node that the volume should be attached to.
-
volumeBindingMode string
-
VolumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is alpha-level and is only honored by servers that enable the VolumeScheduling feature.
The last error encountered during attach operation, if any. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
+
+
+
attached boolean
+
Indicates the volume is successfully attached. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
+
+
+
attachmentMetadata object
+
Upon successful attach, this field is populated with any information returned by the attach operation that must be passed into subsequent WaitForAttach or Mount calls. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
The last error encountered during detach operation, if any. This field must only be set by the entity completing the detach operation, i.e. the external-attacher.
HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
-
-
-
-
-
VolumeAttachment v1alpha1 storage
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
storage
-
v1alpha1
-
VolumeAttachment
-
-
-
-
VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node.
-
VolumeAttachment objects are non-namespaced.
+
ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers.
The last error encountered during attach operation, if any. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
-
-
-
attached boolean
-
Indicates the volume is successfully attached. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
-
-
-
attachmentMetadata object
-
Upon successful attach, this field is populated with any information returned by the attach operation that must be passed into subsequent WaitForAttach or Mount calls. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
The last error encountered during detach operation, if any. This field must only be set by the entity completing the detach operation, i.e. the external-attacher.
+
revision integer
+
Revision indicates the revision of the state represented by Data.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch changes to an object of kind VolumeAttachment
+
list or watch objects of kind ControllerRevision
HTTP Request
-
GET /apis/storage.k8s.io/v1alpha1/watch/volumeattachments/{name}
+
GET /apis/apps/v1/controllerrevisions
+
Query Parameters
+
+
+
+
Parameter
+
Description
+
+
+
+
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
pretty
+
If 'true', then the output is pretty printed.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
+
+
+Coming Soon
+
+
+
+
Output
+
+
+Coming Soon
+
+
+
+
Response Body
+
+
+Coming Soon
+
+
+
watch individual changes to a list of ControllerRevision
+
HTTP Request
+
GET /apis/apps/v1/watch/controllerrevisions
+
Query Parameters
+
+
+
+
Parameter
+
Description
+
+
+
+
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
pretty
+
If 'true', then the output is pretty printed.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -28680,18 +29923,8 @@
Response
-
METADATA
-
Metadata resources are responsible for configuring behavior of your other Resources within the Cluster.
-
Common resource types:
-
-
HorizontalPodAutoscaler (HPA) for automatically scaling the replicacount of your workloads in response to load
-
PodDisruptionBudget for configuring how many replicas in a given workload maybe made concurrently unavailable when performing maintenance.
-
ThirdPartyResource for extending the Kubernetes APIs with your own types
-
Event for notification of resource lifecycle events in the cluster.
-
-
-
ControllerRevision v1 apps
+
CustomResourceDefinition v1beta1 apiextensions
@@ -28702,21 +29935,18 @@
ControllerRevision v1 apps
-
apps
-
v1
-
ControllerRevision
+
apiextensions
+
v1beta1
+
CustomResourceDefinition
-
-
-
-
ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers.
+
CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>.
Subresources describes the subresources for CustomResources This field is alpha-level and should only be sent to servers that enable subresources via the CustomResourceSubresources feature gate.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch changes to an object of kind ControllerRevision
+
watch individual changes to a list of CustomResourceDefinition
HTTP Request
-
GET /apis/apps/v1/watch/namespaces/{namespace}/controllerrevisions/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the ControllerRevision
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
+
GET /apis/apiextensions.k8s.io/v1beta1/watch/customresourcedefinitions
Query Parameters
@@ -29639,7 +30908,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -29662,34 +30931,40 @@
Response
-
Watch List
+
Status Operations
+
See supported operations below...
+
Replace Status
kubectl Command
Coming Soon
+
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch individual changes to a list of ControllerRevision
+
replace status of the specified CustomResourceDefinition
HTTP Request
-
GET /apis/apps/v1/watch/namespaces/{namespace}/controllerrevisions
+
PUT /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}/status
Path Parameters
@@ -29700,8 +30975,8 @@
Path Parameters
-
namespace
-
object name and auth scope, such as for teams and projects
+
name
+
name of the CustomResourceDefinition
@@ -29715,87 +30990,12 @@
Query Parameters
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
pretty
If 'true', then the output is pretty printed.
-
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
-
-
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of ControllerRevision
-
HTTP Request
-
GET /apis/apps/v1/watch/controllerrevisions
-
Query Parameters
+
Body Parameters
@@ -29805,40 +31005,8 @@
Query Parameters
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
-
-
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch individual changes to a list of CustomResourceDefinition
+
watch changes to an object of kind Event
HTTP Request
-
GET /apis/apiextensions.k8s.io/v1beta1/watch/customresourcedefinitions
+
GET /api/v1/watch/namespaces/{namespace}/events/{name}
+
Path Parameters
+
+
+
+
Parameter
+
Description
+
+
+
+
+
name
+
name of the Event
+
+
+
namespace
+
object name and auth scope, such as for teams and projects
+
+
+
Query Parameters
@@ -30802,7 +32062,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -30825,36 +32085,38 @@
Response
-
Status Operations
-
See supported operations below...
-
Replace Status
+
Watch List
kubectl Command
Coming Soon
+
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
replace status of the specified CustomResourceDefinition
+
watch individual changes to a list of Event
HTTP Request
-
PUT /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}/status
+
GET /api/v1/watch/namespaces/{namespace}/events
Path Parameters
@@ -30865,8 +32127,8 @@
Path Parameters
-
name
-
name of the CustomResourceDefinition
+
namespace
+
object name and auth scope, such as for teams and projects
@@ -30880,12 +32142,91 @@
Query Parameters
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
pretty
If 'true', then the output is pretty printed.
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
pretty
+
If 'true', then the output is pretty printed.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
reference to scaled resource; horizontal pod autoscaler will learn the current resource consumption and will set the desired number of pods by using its Scale subresource.
+
+
+
targetCPUUtilizationPercentage integer
+
target average CPU utilization (represented as a percentage of requested CPU) over all the pods; if not specified the default autoscaling policy will be used.
-
LimitRangeList v1 core
+
HorizontalPodAutoscalerStatus v1 autoscaling
+
+
+
+
+
+
Field
+
Description
+
+
+
+
+
currentCPUUtilizationPercentage integer
+
current average CPU utilization over all pods, represented as a percentage of requested CPU, e.g. 70 means that an average pod is using now 70% of its requested CPU.
+
+
+
currentReplicas integer
+
current number of replicas of pods managed by this autoscaler.
+
+
+
desiredReplicas integer
+
desired number of replicas of pods managed by this autoscaler.
reference to scaled resource; horizontal pod autoscaler will learn the current resource consumption and will set the desired number of pods by using its Scale subresource.
-
-
-
targetCPUUtilizationPercentage integer
-
target average CPU utilization (represented as a percentage of requested CPU) over all the pods; if not specified the default autoscaling policy will be used.
-
-
-
-
HorizontalPodAutoscalerStatus v1 autoscaling
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
currentCPUUtilizationPercentage integer
-
current average CPU utilization over all pods, represented as a percentage of requested CPU, e.g. 70 means that an average pod is using now 70% of its requested CPU.
-
-
-
currentReplicas integer
-
current number of replicas of pods managed by this autoscaler.
-
-
-
desiredReplicas integer
-
desired number of replicas of pods managed by this autoscaler.
initializers Initializer array patch type: merge patch merge key: name
+
Initializers is a list of resources and their default initializers Order-sensitive. When merging multiple InitializerConfigurations, we sort the initializers from different InitializerConfigurations by the name of the InitializerConfigurations; the order of the initializers from the same InitializerConfiguration is preserved.
object name and auth scope, such as for teams and projects
-
-
-
+
POST /apis/admissionregistration.k8s.io/v1alpha1/initializerconfigurations
Query Parameters
@@ -33820,18 +35202,6 @@
Query Parameters
pretty
If 'true', then the output is pretty printed.
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. 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.
object name and auth scope, such as for teams and projects
+
name
+
name of the InitializerConfiguration
@@ -33920,37 +35302,20 @@
Query Parameters
pretty
If 'true', then the output is pretty printed.
+
+
+
Body Parameters
+
+
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
+
Parameter
+
Description
+
+
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
object name and auth scope, such as for teams and projects
+
name
+
name of the InitializerConfiguration
@@ -34113,36 +35491,31 @@
Query Parameters
If 'true', then the output is pretty printed.
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
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.
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
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.
-
resourceVersion
-
When 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.
+
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.
+
+
+
Body Parameters
+
+
-
timeoutSeconds
-
Timeout for the list/watch call.
+
Parameter
+
Description
+
+
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
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.
@@ -34219,16 +35600,12 @@
Query Parameters
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
pretty
-
If 'true', then the output is pretty printed.
-
-
resourceVersion
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
curl Command (requires kubectl proxy to be running)
+
+
+Coming Soon
+
+
+
+
Output
+
+
+Coming Soon
+
+
+
+
Response Body
+
+
+Coming Soon
+
+
+
list or watch objects of kind InitializerConfiguration
+
HTTP Request
+
GET /apis/admissionregistration.k8s.io/v1alpha1/initializerconfigurations
Query Parameters
@@ -34308,6 +35757,10 @@
Query Parameters
+
pretty
+
If 'true', then the output is pretty printed.
+
+
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.
@@ -34328,16 +35781,12 @@
Query Parameters
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
pretty
-
If 'true', then the output is pretty printed.
-
-
resourceVersion
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
initializers Initializer array patch type: merge patch merge key: name
-
Initializers is a list of resources and their default initializers Order-sensitive. When merging multiple InitializerConfigurations, we sort the initializers from different InitializerConfigurations by the name of the InitializerConfigurations; the order of the initializers from the same InitializerConfiguration is preserved.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch changes to an object of kind ValidatingWebhookConfiguration
+
list or watch objects of kind PodTemplate
HTTP Request
-
GET /apis/admissionregistration.k8s.io/v1beta1/watch/validatingwebhookconfigurations/{name}
+
GET /api/v1/podtemplates
+
Query Parameters
+
+
+
+
Parameter
+
Description
+
+
+
+
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
pretty
+
If 'true', then the output is pretty printed.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
+
+
+Coming Soon
+
+
+
+
Output
+
+
+Coming Soon
+
+
+
+
Response Body
+
+
+Coming Soon
+
+
+
watch individual changes to a list of PodTemplate
+
HTTP Request
+
GET /api/v1/watch/podtemplates
+
Query Parameters
+
+
+
+
Parameter
+
Description
+
+
+
+
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
pretty
+
If 'true', then the output is pretty printed.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -37523,7 +39130,7 @@
Response
-
PodTemplate v1 core
+
PodDisruptionBudget v1beta1 policy
@@ -37534,18 +39141,18 @@
PodTemplate v1 core
-
Core
-
v1
-
PodTemplate
+
policy
+
v1beta1
+
PodDisruptionBudget
-
PodTemplate describes a template for creating copies of a predefined pod.
+
PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods
An eviction is allowed if at most "maxUnavailable" pods selected by "selector" are unavailable after the eviction, i.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions by specifying 0. This is a mutually exclusive setting with "minAvailable".
An eviction is allowed if at least "minAvailable" pods selected by "selector" will still be available after the eviction, i.e. even in the absence of the evicted pod. So for example you can prevent all voluntary evictions by specifying "100%".
Label query over pods whose evictions are managed by the disruption budget.
-
PodTemplateList v1 core
+
PodDisruptionBudgetStatus v1beta1 policy
+
+
+
+
+
+
Field
+
Description
+
+
+
+
+
currentHealthy integer
+
current number of healthy pods
+
+
+
desiredHealthy integer
+
minimum desired number of healthy pods
+
+
+
disruptedPods object
+
DisruptedPods contains information about pods whose eviction was processed by the API server eviction subresource handler but has not yet been observed by the PodDisruptionBudget controller. A pod will be in this map from the time when the API server processed the eviction request to the time when the pod is seen by PDB controller as having been marked for deletion (or after a timeout). The key in the map is the name of the pod and the value is the time when the API server processed the eviction request. If the deletion didn't occur and a pod is still there it will be removed from the list automatically by PodDisruptionBudget controller after some time. If everything goes smooth this map should be empty for the most of the time. Large number of entries in the map may indicate problems with pod deletions.
+
+
+
disruptionsAllowed integer
+
Number of pod disruptions that are currently allowed.
+
+
+
expectedPods integer
+
total number of pods counted by this disruption budget
+
+
+
observedGeneration integer
+
Most recent generation observed when updating this PDB status. PodDisruptionsAllowed and other status informatio is valid only if observedGeneration equals to PDB's object generation.
Most recently observed status of the PodDisruptionBudget.
+
namespace
+
object name and auth scope, such as for teams and projects
-
PodDisruptionBudgetSpec v1beta1 policy
-
-
+
Query Parameters
-
Field
+
Parameter
Description
-
maxUnavailable
-
An eviction is allowed if at most "maxUnavailable" pods selected by "selector" are unavailable after the eviction, i.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions by specifying 0. This is a mutually exclusive setting with "minAvailable".
-
-
-
minAvailable
-
An eviction is allowed if at least "minAvailable" pods selected by "selector" will still be available after the eviction, i.e. even in the absence of the evicted pod. So for example you can prevent all voluntary evictions by specifying "100%".
Label query over pods whose evictions are managed by the disruption budget.
+
pretty
+
If 'true', then the output is pretty printed.
-
PodDisruptionBudgetStatus v1beta1 policy
-
-
+
Body Parameters
-
Field
+
Parameter
Description
-
currentHealthy integer
-
current number of healthy pods
-
-
-
desiredHealthy integer
-
minimum desired number of healthy pods
-
-
-
disruptedPods object
-
DisruptedPods contains information about pods whose eviction was processed by the API server eviction subresource handler but has not yet been observed by the PodDisruptionBudget controller. A pod will be in this map from the time when the API server processed the eviction request to the time when the pod is seen by PDB controller as having been marked for deletion (or after a timeout). The key in the map is the name of the pod and the value is the time when the API server processed the eviction request. If the deletion didn't occur and a pod is still there it will be removed from the list automatically by PodDisruptionBudget controller after some time. If everything goes smooth this map should be empty for the most of the time. Large number of entries in the map may indicate problems with pod deletions.
-
-
-
disruptionsAllowed integer
-
Number of pod disruptions that are currently allowed.
-
-
-
expectedPods integer
-
total number of pods counted by this disruption budget
-
-
-
observedGeneration integer
-
Most recent generation observed when updating this PDB status. PodDisruptionsAllowed and other status informatio is valid only if observedGeneration equals to PDB's object generation.
description is an arbitrary string that usually provides guidelines on when this priority class should be used.
+
+
+
globalDefault boolean
+
globalDefault specifies whether this PriorityClass should be considered as the default priority for pods that do not have any priority class. Only one PriorityClass can be marked as globalDefault. However, if more than one PriorityClasses exists with their globalDefault field set to true, the smallest value of such global default PriorityClasses will be used as the default priority.
object name and auth scope, such as for teams and projects
+
name of the PriorityClass
@@ -39224,18 +40928,6 @@
Query Parameters
pretty
If 'true', then the output is pretty printed.
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. 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.
PUT /apis/scheduling.k8s.io/v1alpha1/priorityclasses/{name}
Path Parameters
@@ -39306,8 +41002,8 @@
Path Parameters
-
namespace
-
object name and auth scope, such as for teams and projects
+
name
+
name of the PriorityClass
@@ -39324,37 +41020,20 @@
Query Parameters
pretty
If 'true', then the output is pretty printed.
+
+
+
Body Parameters
+
+
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
+
Parameter
+
Description
+
+
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
object name and auth scope, such as for teams and projects
+
name of the PriorityClass
@@ -39436,12 +41117,31 @@
Query Parameters
If 'true', then the output is pretty printed.
-
exact
-
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
+
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.
-
export
-
Should this value be exported. Export strips fields that a user can not specify.
+
orphanDependents
+
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
+
+
+
propagationPolicy
+
Whether and how garbage collection will be performed. 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.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
list or watch objects of kind PodDisruptionBudget
+
read the specified PriorityClass
HTTP Request
-
GET /apis/policy/v1beta1/poddisruptionbudgets
-
Query Parameters
+
GET /apis/scheduling.k8s.io/v1alpha1/priorityclasses/{name}
+
Path Parameters
@@ -39603,40 +41298,31 @@
Query Parameters
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
name
+
name of the PriorityClass
+
+
+
Query Parameters
+
+
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
Parameter
+
Description
+
+
pretty
If 'true', then the output is pretty printed.
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
+
exact
+
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
export
+
Should this value be exported. Export strips fields that a user can not specify.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch changes to an object of kind PodDisruptionBudget
+
list or watch objects of kind PriorityClass
HTTP Request
-
GET /apis/policy/v1beta1/watch/namespaces/{namespace}/poddisruptionbudgets/{name}
-
Path Parameters
+
GET /apis/scheduling.k8s.io/v1alpha1/priorityclasses
+
Query Parameters
@@ -39693,24 +41383,9 @@
Path Parameters
-
name
-
name of the PodDisruptionBudget
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
+
pretty
+
If 'true', then the output is pretty printed.
-
-
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.
@@ -39732,16 +41407,12 @@
Query Parameters
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
pretty
-
If 'true', then the output is pretty printed.
-
-
resourceVersion
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch individual changes to a list of PriorityClass
+
watch changes to an object of kind PodPreset
HTTP Request
-
GET /apis/scheduling.k8s.io/v1alpha1/watch/priorityclasses
+
GET /apis/settings.k8s.io/v1alpha1/watch/namespaces/{namespace}/podpresets/{name}
+
Path Parameters
+
+
+
+
Parameter
+
Description
+
+
+
+
+
name
+
name of the PodPreset
+
+
+
namespace
+
object name and auth scope, such as for teams and projects
+
+
+
Query Parameters
@@ -41117,7 +42660,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -41140,36 +42683,233 @@
Response
-
-
PodPreset v1alpha1 settings
+
Watch List
+
+
kubectl Command
+
+
+Coming Soon
+
+
+
+
curl Command (requires kubectl proxy to be running)
+
+
+Coming Soon
+
+
+
+
Output
+
+
+Coming Soon
+
+
+
+
Response Body
+
+
+Coming Soon
+
+
+
watch individual changes to a list of PodPreset
+
HTTP Request
+
GET /apis/settings.k8s.io/v1alpha1/watch/namespaces/{namespace}/podpresets
+
Path Parameters
-
Group
-
Version
-
Kind
+
Parameter
+
Description
-
settings
-
v1alpha1
-
PodPreset
+
namespace
+
object name and auth scope, such as for teams and projects
-
-
+
Query Parameters
+
+
+
+
Parameter
+
Description
+
+
+
+
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
pretty
+
If 'true', then the output is pretty printed.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
+
+
+Coming Soon
+
+
+
Output
+
+
+Coming Soon
+
+
+
Response Body
+
+
+Coming Soon
-
PodPreset is a policy resource that defines additional runtime requirements for a Pod.
+
+
watch individual changes to a list of PodPreset
+
HTTP Request
+
GET /apis/settings.k8s.io/v1alpha1/watch/podpresets
+
Query Parameters
+
+
+
+
Parameter
+
Description
+
+
+
+
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
pretty
+
If 'true', then the output is pretty printed.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
EnvFrom defines the collection of EnvFromSource to inject into containers.
+
allowedCapabilities string array
+
AllowedCapabilities is a list of capabilities that can be requested to add to the container. Capabilities in this field may be added at the pod author's discretion. You must not list a capability in both AllowedCapabilities and RequiredDropCapabilities.
AllowedFlexVolumes is a whitelist of allowed Flexvolumes. Empty or nil indicates that all Flexvolumes may be used. This parameter is effective only when the usage of the Flexvolumes is allowed in the "Volumes" field.
Volumes defines the collection of Volume to inject into the pod.
+
defaultAddCapabilities string array
+
DefaultAddCapabilities is the default set of capabilities that will be added to the container unless the pod spec specifically drops the capability. You may not list a capability in both DefaultAddCapabilities and RequiredDropCapabilities. Capabilities added here are implicitly allowed, and need not be included in the AllowedCapabilities list.
+
+
+
defaultAllowPrivilegeEscalation boolean
+
DefaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process.
hostPorts determines which host port ranges are allowed to be exposed.
+
+
+
privileged boolean
+
privileged determines if a pod can request to be run as privileged.
+
+
+
readOnlyRootFilesystem boolean
+
ReadOnlyRootFilesystem when set to true will force containers to run with a read only root file system. If the container specifically requests to run with a non-read only root file system the PSP should deny the pod. If set to false the container may run with a read only root file system if it wishes but it will not be forced to.
+
+
+
requiredDropCapabilities string array
+
RequiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch changes to an object of kind PodPreset
+
watch individual changes to a list of PodSecurityPolicy
HTTP Request
-
GET /apis/settings.k8s.io/v1alpha1/watch/namespaces/{namespace}/podpresets/{name}
-
Path Parameters
+
GET /apis/extensions/v1beta1/watch/podsecuritypolicies
+
Query Parameters
@@ -42078,132 +43860,8 @@
Path Parameters
-
name
-
name of the PodPreset
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
-
-
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of PodPreset
-
HTTP Request
-
GET /apis/settings.k8s.io/v1alpha1/watch/namespaces/{namespace}/podpresets
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
+
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.
fieldSelector
@@ -42231,97 +43889,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
-
-
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of PodPreset
-
HTTP Request
-
GET /apis/settings.k8s.io/v1alpha1/watch/podpresets
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -42344,8 +43912,11 @@
Response
+
CLUSTER
+
Cluster resources are responsible for defining configuration of the cluster itself, and are generally only used by cluster operators.
-
PodSecurityPolicy v1beta1 extensions
+
+
APIService v1beta1 apiregistration
@@ -42356,18 +43927,21 @@
PodSecurityPolicy v1beta1 extensio
-
extensions
+
apiregistration
v1beta1
-
PodSecurityPolicy
+
APIService
-
Pod Security Policy governs the ability to make requests that affect the Security Context that will be applied to a pod and container.
+
+
+
+
APIService represents a server for a particular GroupVersion. Name must be "version.group".
Status contains derived information about an API server
-
PodSecurityPolicySpec v1beta1 extensions
+
APIServiceSpec v1beta1 apiregistration
@@ -42413,80 +43991,58 @@
PodSecurityPolicySpec v1beta1
-
allowPrivilegeEscalation boolean
-
AllowPrivilegeEscalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true.
-
-
-
allowedCapabilities string array
-
AllowedCapabilities is a list of capabilities that can be requested to add to the container. Capabilities in this field may be added at the pod author's discretion. You must not list a capability in both AllowedCapabilities and RequiredDropCapabilities.
AllowedFlexVolumes is a whitelist of allowed Flexvolumes. Empty or nil indicates that all Flexvolumes may be used. This parameter is effective only when the usage of the Flexvolumes is allowed in the "Volumes" field.
is a white list of allowed host paths. Empty indicates that all host paths may be used.
-
-
-
defaultAddCapabilities string array
-
DefaultAddCapabilities is the default set of capabilities that will be added to the container unless the pod spec specifically drops the capability. You may not list a capability in both DefaultAddCapabilities and RequiredDropCapabilities. Capabilities added here are implicitly allowed, and need not be included in the AllowedCapabilities list.
-
-
-
defaultAllowPrivilegeEscalation boolean
-
DefaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process.
hostPorts determines which host port ranges are allowed to be exposed.
+
group string
+
Group is the API group name this server hosts
-
privileged boolean
-
privileged determines if a pod can request to be run as privileged.
+
groupPriorityMinimum integer
+
GroupPriorityMininum is the priority this group should have at least. Higher priority means that the group is preferred by clients over lower priority ones. Note that other versions of this group might specify even higher GroupPriorityMininum values such that the whole group gets a higher priority. The primary sort is based on GroupPriorityMinimum, ordered highest number to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) We'd recommend something like: *.k8s.io (except extensions) at 18000 and PaaSes (OpenShift, Deis) are recommended to be in the 2000s
-
readOnlyRootFilesystem boolean
-
ReadOnlyRootFilesystem when set to true will force containers to run with a read only root file system. If the container specifically requests to run with a non-read only root file system the PSP should deny the pod. If set to false the container may run with a read only root file system if it wishes but it will not be forced to.
+
insecureSkipTLSVerify boolean
+
InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. This is strongly discouraged. You should use the CABundle instead.
-
requiredDropCapabilities string array
-
RequiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added.
Service is a reference to the service for this API server. It must communicate on port 443 If the Service is nil, that means the handling for the API groupversion is handled locally on this server. The call will simply delegate to the normal handler chain to be fulfilled.
seLinux is the strategy that will dictate the allowable labels that may be set.
+
versionPriority integer
+
VersionPriority controls the ordering of this API version inside of its group. Must be greater than zero. The primary sort is based on VersionPriority, ordered highest to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) Since it's inside of a group, the number can be small, probably in the 10s.
Binding ties one object to another; for example, a pod is bound to a node by a scheduler. Deprecated in 1.7, please use the bindings subresource of pods instead.
CABundle is a PEM encoded CA bundle which will be used to validate an API server's serving certificate.
-
-
-
group string
-
Group is the API group name this server hosts
+
extra object
+
Extra information about the requesting user. See user.Info interface for details.
-
groupPriorityMinimum integer
-
GroupPriorityMininum is the priority this group should have at least. Higher priority means that the group is preferred by clients over lower priority ones. Note that other versions of this group might specify even higher GroupPriorityMininum values such that the whole group gets a higher priority. The primary sort is based on GroupPriorityMinimum, ordered highest number to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) We'd recommend something like: *.k8s.io (except extensions) at 18000 and PaaSes (OpenShift, Deis) are recommended to be in the 2000s
+
groups string array
+
Group information about the requesting user. See user.Info interface for details.
-
insecureSkipTLSVerify boolean
-
InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. This is strongly discouraged. You should use the CABundle instead.
Service is a reference to the service for this API server. It must communicate on port 443 If the Service is nil, that means the handling for the API groupversion is handled locally on this server. The call will simply delegate to the normal handler chain to be fulfilled.
+
uid string
+
UID information about the requesting user. See user.Info interface for details.
-
version string
-
Version is the API version this server hosts. For example, "v1"
VersionPriority controls the ordering of this API version inside of its group. Must be greater than zero. The primary sort is based on VersionPriority, ordered highest to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) Since it's inside of a group, the number can be small, probably in the 10s.
+
username string
+
Information about the requesting user. See user.Info interface for details.
Binding ties one object to another; for example, a pod is bound to a node by a scheduler. Deprecated in 1.7, please use the bindings subresource of pods instead.
+
+
+
+
ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding.
AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. If AggregationRule is set, then the Rules are controller managed and direct changes to Rules will be stomped by the controller.
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
+
+
+
orphanDependents
+
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
+
+
+
propagationPolicy
+
Whether and how garbage collection will be performed. 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.
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.
-
-
-
pretty
-
If 'true', then the output is pretty printed.
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
Body Parameters
-
-
-
Parameter
-
Description
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
GET /apis/rbac.authorization.k8s.io/v1/clusterroles/{name}
Path Parameters
@@ -44999,7 +46881,7 @@
Path Parameters
name
-
name of the CertificateSigningRequest
+
name of the ClusterRole
@@ -45016,33 +46898,6 @@
Query Parameters
pretty
If 'true', then the output is pretty printed.
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. 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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind CertificateSigningRequest
-
HTTP Request
-
GET /apis/certificates.k8s.io/v1beta1/certificatesigningrequests
Query Parameters
@@ -45271,10 +47066,6 @@
Query Parameters
-
pretty
-
If 'true', then the output is pretty printed.
-
-
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.
@@ -45295,12 +47086,16 @@
Query Parameters
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
pretty
+
If 'true', then the output is pretty printed.
+
+
resourceVersion
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch changes to an object of kind CertificateSigningRequest
+
watch individual changes to a list of ClusterRole
HTTP Request
-
GET /apis/certificates.k8s.io/v1beta1/watch/certificatesigningrequests/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the CertificateSigningRequest
-
-
-
+
GET /apis/rbac.authorization.k8s.io/v1/watch/clusterroles
Query Parameters
@@ -45405,7 +47189,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -45428,192 +47212,8 @@
Response
-
Watch List
-
-
kubectl Command
-
-
-Coming Soon
-
-
-
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of CertificateSigningRequest
-
HTTP Request
-
GET /apis/certificates.k8s.io/v1beta1/watch/certificatesigningrequests
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
-
-
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding.
+
ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject.
AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. If AggregationRule is set, then the Rules are controller managed and direct changes to Rules will be stomped by the controller.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch changes to an object of kind ClusterRole
+
watch changes to an object of kind ClusterRoleBinding
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1/watch/clusterroles/{name}
+
GET /apis/rbac.authorization.k8s.io/v1/watch/clusterrolebindings/{name}
Path Parameters
@@ -46355,7 +47987,7 @@
Path Parameters
name
-
name of the ClusterRole
+
name of the ClusterRoleBinding
@@ -46398,7 +48030,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -46421,34 +48053,38 @@
Response
-
Watch List
+
Watch List
kubectl Command
Coming Soon
+
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch individual changes to a list of ClusterRole
+
watch individual changes to a list of ClusterRoleBinding
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1/watch/clusterroles
+
GET /apis/rbac.authorization.k8s.io/v1/watch/clusterrolebindings
Query Parameters
@@ -46488,7 +48124,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -46512,7 +48148,7 @@
Response
-
ClusterRoleBinding v1 rbac
+
ComponentStatus v1 core
@@ -46523,21 +48159,18 @@
ClusterRoleBinding v1 rbac
-
rbac
+
Core
v1
-
ClusterRoleBinding
+
ComponentStatus
-
-
-
-
ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject.
+
ComponentStatus (and ComponentStatusList) holds the cluster validation info.
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
pretty
+
If 'true', then the output is pretty printed.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace. Having a namespace scoped resource makes it much easier to grant namespace scoped policy that includes permissions checking.
Spec holds information about the request being evaluated. spec.namespace must be equal to the namespace you made the request against. If empty, it is defaulted.
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.
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.
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.
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
+
Parameter
+
Description
+
+
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
list or watch objects of kind ClusterRoleBinding
+
replace the specified Namespace
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1/clusterrolebindings
-
Query Parameters
+
PUT /api/v1/namespaces/{name}
+
Path Parameters
@@ -47163,40 +48901,38 @@
Query Parameters
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
name
+
name of the Namespace
+
+
+
Query Parameters
+
+
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
Parameter
+
Description
+
+
-
resourceVersion
-
When 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.
+
pretty
+
If 'true', then the output is pretty printed.
+
+
+
Body Parameters
+
+
-
timeoutSeconds
-
Timeout for the list/watch call.
+
Parameter
+
Description
+
+
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch changes to an object of kind ClusterRoleBinding
+
delete a Namespace
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1/watch/clusterrolebindings/{name}
+
DELETE /api/v1/namespaces/{name}
Path Parameters
@@ -47254,7 +48998,7 @@
Path Parameters
name
-
name of the ClusterRoleBinding
+
name of the Namespace
@@ -47268,40 +49012,35 @@
Query Parameters
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
pretty
+
If 'true', then the output is pretty printed.
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
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.
-
pretty
-
If 'true', then the output is pretty printed.
+
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.
-
resourceVersion
-
When 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.
+
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.
+
+
+
Body Parameters
+
+
-
timeoutSeconds
-
Timeout for the list/watch call.
+
Parameter
+
Description
+
+
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch individual changes to a list of ClusterRoleBinding
+
read the specified Namespace
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1/watch/clusterrolebindings
-
Query Parameters
+
GET /api/v1/namespaces/{name}
+
Path Parameters
@@ -47358,40 +49103,31 @@
Query Parameters
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
name
+
name of the Namespace
+
+
+
Query Parameters
+
+
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
Parameter
+
Description
+
+
pretty
If 'true', then the output is pretty printed.
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
+
exact
+
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
export
+
Should this value be exported. Export strips fields that a user can not specify.
curl Command (requires kubectl proxy to be running)
+
+
+Coming Soon
+
+
+
+
Output
+
+
+Coming Soon
+
+
+
+
Response Body
+
+
+Coming Soon
+
+
+
list or watch objects of kind Namespace
+
HTTP Request
+
GET /api/v1/namespaces
+
Query Parameters
-
Group
-
Version
-
Kind
+
Parameter
+
Description
-
Core
-
v1
-
ComponentStatus
+
pretty
+
If 'true', then the output is pretty printed.
-
-
-
ComponentStatus (and ComponentStatusList) holds the cluster validation info.
-
-
-
-
-
Field
-
Description
+
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.
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
read the specified ComponentStatus
+
watch changes to an object of kind Namespace
HTTP Request
-
GET /api/v1/componentstatuses/{name}
+
GET /api/v1/watch/namespaces/{name}
Path Parameters
@@ -47530,7 +49283,7 @@
Path Parameters
name
-
name of the ComponentStatus
+
name of the Namespace
@@ -47544,9 +49297,41 @@
Query Parameters
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
pretty
If 'true', then the output is pretty printed.
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace. Having a namespace scoped resource makes it much easier to grant namespace scoped policy that includes permissions checking.
Spec holds information about the request being evaluated. spec.namespace must be equal to the namespace you made the request against. If empty, it is defaulted.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
delete a Namespace
+
create a Node
HTTP Request
-
DELETE /api/v1/namespaces/{name}
-
Path Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
name
-
name of the Namespace
-
-
-
+
POST /api/v1/nodes
Query Parameters
@@ -48250,18 +49940,6 @@
Query Parameters
pretty
If 'true', then the output is pretty printed.
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. 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.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
list or watch objects of kind Namespace
+
replace the specified Node
HTTP Request
-
GET /api/v1/namespaces
-
Query Parameters
+
PUT /api/v1/nodes/{name}
+
Path Parameters
@@ -48415,40 +50114,38 @@
Query Parameters
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
name
+
name of the Node
+
+
+
Query Parameters
+
+
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
Parameter
+
Description
+
+
-
resourceVersion
-
When 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.
+
pretty
+
If 'true', then the output is pretty printed.
+
+
+
Body Parameters
+
+
-
timeoutSeconds
-
Timeout for the list/watch call.
+
Parameter
+
Description
+
+
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch changes to an object of kind Namespace
+
delete a Node
HTTP Request
-
GET /api/v1/watch/namespaces/{name}
+
DELETE /api/v1/nodes/{name}
Path Parameters
@@ -48506,7 +50211,7 @@
Path Parameters
name
-
name of the Namespace
+
name of the Node
@@ -48520,40 +50225,35 @@
Query Parameters
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
pretty
+
If 'true', then the output is pretty printed.
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
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.
-
pretty
-
If 'true', then the output is pretty printed.
+
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.
-
resourceVersion
-
When 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.
+
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.
+
+
+
Body Parameters
+
+
-
timeoutSeconds
-
Timeout for the list/watch call.
+
Parameter
+
Description
+
+
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch individual changes to a list of Namespace
+
delete collection of Node
HTTP Request
-
GET /api/v1/watch/namespaces
+
DELETE /api/v1/nodes
Query Parameters
@@ -48610,6 +50314,10 @@
Query Parameters
+
pretty
+
If 'true', then the output is pretty printed.
+
+
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.
@@ -48630,16 +50338,12 @@
Query Parameters
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
pretty
-
If 'true', then the output is pretty printed.
-
-
resourceVersion
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
read status of the specified Namespace
+
list or watch objects of kind Node
HTTP Request
-
GET /api/v1/namespaces/{name}/status
-
Path Parameters
+
GET /api/v1/nodes
+
Query Parameters
@@ -48790,23 +50495,40 @@
Path Parameters
-
name
-
name of the Namespace
+
pretty
+
If 'true', then the output is pretty printed.
-
-
-
Query Parameters
-
-
-
Parameter
-
Description
+
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.
-
-
-
pretty
-
If 'true', then the output is pretty printed.
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
replace status of the specified Namespace
+
watch changes to an object of kind Node
HTTP Request
-
PUT /api/v1/namespaces/{name}/status
+
GET /api/v1/watch/nodes/{name}
Path Parameters
@@ -48864,7 +50590,7 @@
Path Parameters
name
-
name of the Namespace
+
name of the Node
@@ -48878,258 +50604,201 @@
Query Parameters
-
pretty
-
If 'true', then the output is pretty printed.
+
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.
-
-
-
Body Parameters
-
-
-
Parameter
-
Description
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
When 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.
Allocatable represents the resources of a node that are available for scheduling. Defaults to Capacity.
+
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.
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
When 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.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
replace the specified Node
+
replace status of the specified Node
HTTP Request
-
PUT /api/v1/nodes/{name}
+
PUT /api/v1/nodes/{name}/status
Path Parameters
@@ -49363,34 +51017,40 @@
Response
-
Delete
+
Proxy Operations
+
See supported operations below...
+
Create Connect Proxy
kubectl Command
Coming Soon
+
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
delete a Node
+
connect POST requests to proxy of Node
HTTP Request
-
DELETE /api/v1/nodes/{name}
+
POST /api/v1/nodes/{name}/proxy
Path Parameters
@@ -49416,35 +51076,8 @@
Query Parameters
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. 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.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
delete collection of Node
+
connect POST requests to proxy of Node
HTTP Request
-
DELETE /api/v1/nodes
-
Query Parameters
+
POST /api/v1/nodes/{name}/proxy/{path}
+
Path Parameters
@@ -49501,40 +51138,27 @@
Query Parameters
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
name
+
name of the Node
-
resourceVersion
-
When 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.
+
path
+
path to the resource
+
+
+
Query Parameters
+
+
-
timeoutSeconds
-
Timeout for the list/watch call.
+
Parameter
+
Description
+
+
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
path
+
Path is the URL path to use for the current proxy request to node.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
list or watch objects of kind Node
+
connect DELETE requests to proxy of Node
HTTP Request
-
GET /api/v1/nodes
-
Query Parameters
+
DELETE /api/v1/nodes/{name}/proxy/{path}
+
Path Parameters
@@ -49674,40 +51296,27 @@
Query Parameters
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
name
+
name of the Node
-
resourceVersion
-
When 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.
+
path
+
path to the resource
+
+
+
Query Parameters
+
+
-
timeoutSeconds
-
Timeout for the list/watch call.
+
Parameter
+
Description
+
+
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
path
+
Path is the URL path to use for the current proxy request to node.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch changes to an object of kind Node
+
connect GET requests to proxy of Node
HTTP Request
-
GET /api/v1/watch/nodes/{name}
+
GET /api/v1/nodes/{name}/proxy
Path Parameters
@@ -49779,40 +51392,8 @@
Query Parameters
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
-
-
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
path
+
Path is the URL path to use for the current proxy request to node.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch individual changes to a list of Node
+
connect GET requests to proxy of Node
HTTP Request
-
GET /api/v1/watch/nodes
-
Query Parameters
+
GET /api/v1/nodes/{name}/proxy/{path}
+
Path Parameters
@@ -49869,46 +51454,33 @@
Query Parameters
-
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.
+
name
+
name of the Node
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
path
+
path to the resource
+
+
+
Query Parameters
+
+
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
+
Parameter
+
Description
+
+
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
path
+
Path is the URL path to use for the current proxy request to node.
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
-
-
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
Flocker represents a Flocker volume attached to a kubelet's host machine and exposed to the pod for its usage. This depends on the Flocker control service being running
HostPath represents a directory on the host. Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
NodeAffinity defines constraints that limit what nodes this volume can be accessed from. This field influences the scheduling of pods that use this volume.
+
+
+
persistentVolumeReclaimPolicy string
+
What happens to a persistent volume when released from its claim. Valid options are Retain (default for manually created PersistentVolumes), Delete (default for dynamically provisioned PersistentVolumes), and Recycle (deprecated). Recycle must be supported by the volume plugin underlying this PersistentVolume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming
volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. Value of Filesystem is implied when not included in spec. This is an alpha feature and may change in the future.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
proxy DELETE requests to Node
+
delete a PersistentVolume
HTTP Request
-
DELETE /api/v1/proxy/nodes/{name}
+
DELETE /api/v1/persistentvolumes/{name}
Path Parameters
@@ -50637,54 +52383,38 @@
Path Parameters
name
-
name of the Node
+
name of the PersistentVolume
-
Response
+
Query Parameters
-
Code
+
Parameter
Description
-
200 string
-
OK
+
pretty
+
If 'true', then the output is pretty printed.
+
+
+
gracePeriodSeconds
+
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
+
+
+
orphanDependents
+
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
+
+
+
propagationPolicy
+
Whether and how garbage collection will be performed. 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.
-
Delete Proxy Path
-
-
kubectl Command
-
-
-Coming Soon
-
-
-
curl Command (requires kubectl proxy to be running)
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
connect GET requests to proxy of Node
+
delete collection of PersistentVolume
HTTP Request
-
GET /api/v1/nodes/{name}/proxy
-
Path Parameters
+
DELETE /api/v1/persistentvolumes
+
Query Parameters
@@ -50756,23 +52486,40 @@
Path Parameters
-
name
-
name of the Node
+
pretty
+
If 'true', then the output is pretty printed.
-
-
-
Query Parameters
-
-
-
Parameter
-
Description
+
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.
-
-
-
path
-
Path is the URL path to use for the current proxy request to node.
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
proxy GET requests to Node
+
list or watch objects of kind PersistentVolume
HTTP Request
-
GET /api/v1/proxy/nodes/{name}
-
Path Parameters
+
GET /api/v1/persistentvolumes
+
Query Parameters
@@ -50906,70 +52667,40 @@
Path Parameters
-
name
-
name of the Node
+
pretty
+
If 'true', then the output is pretty printed.
-
-
-
Response
-
-
-
Code
-
Description
+
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.
-
-
-
200 string
-
OK
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
Get Proxy Path
-
-
kubectl Command
-
-
-Coming Soon
-
-
-
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
proxy GET requests to Node
-
HTTP Request
-
GET /api/v1/proxy/nodes/{name}/{path}
-
Path Parameters
-
-
-
Parameter
-
Description
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
-
-
-
name
-
name of the Node
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
path
-
path to the resource
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
connect HEAD requests to proxy of Node
+
watch changes to an object of kind PersistentVolume
HTTP Request
-
HEAD /api/v1/nodes/{name}/proxy
+
GET /api/v1/watch/persistentvolumes/{name}
Path Parameters
@@ -51027,7 +52762,7 @@
Path Parameters
name
-
name of the Node
+
name of the PersistentVolume
@@ -51041,8 +52776,40 @@
Query Parameters
-
path
-
Path is the URL path to use for the current proxy request to node.
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
pretty
+
If 'true', then the output is pretty printed.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
connect HEAD requests to proxy of Node
+
watch individual changes to a list of PersistentVolume
HTTP Request
-
HEAD /api/v1/nodes/{name}/proxy/{path}
-
Path Parameters
+
GET /api/v1/watch/persistentvolumes
+
Query Parameters
@@ -51099,27 +52870,40 @@
Path Parameters
-
name
-
name of the Node
+
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.
-
path
-
path to the resource
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
Query Parameters
-
-
-
Parameter
-
Description
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
-
-
-
path
-
Path is the URL path to use for the current proxy request to node.
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
pretty
+
If 'true', then the output is pretty printed.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
Flocker represents a Flocker volume attached to a kubelet's host machine and exposed to the pod for its usage. This depends on the Flocker control service being running
HostPath represents a directory on the host. Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. Value of Filesystem is implied when not included in spec. This is an alpha feature and may change in the future.
curl Command (requires kubectl proxy to be running)
+
+
+Coming Soon
+
+
+
+
Output
+
+
+Coming Soon
+
+
+
+
Response Body
+
+
+Coming Soon
+
+
+
list or watch objects of kind ResourceQuota
+
HTTP Request
+
GET /api/v1/resourcequotas
+
Query Parameters
+
+
+
+
Parameter
+
Description
+
+
+
+
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
pretty
+
If 'true', then the output is pretty printed.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch changes to an object of kind PersistentVolume
+
watch changes to an object of kind ResourceQuota
HTTP Request
-
GET /api/v1/watch/persistentvolumes/{name}
+
GET /api/v1/watch/namespaces/{namespace}/resourcequotas/{name}
Path Parameters
@@ -52325,7 +54176,11 @@
Path Parameters
name
-
name of the PersistentVolume
+
name of the ResourceQuota
+
+
+
namespace
+
object name and auth scope, such as for teams and projects
@@ -52368,7 +54223,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -52397,28 +54252,141 @@
Watch List
Coming Soon
+
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch individual changes to a list of PersistentVolume
+
watch individual changes to a list of ResourceQuota
HTTP Request
-
GET /api/v1/watch/persistentvolumes
+
GET /api/v1/watch/namespaces/{namespace}/resourcequotas
+
Path Parameters
+
+
+
+
Parameter
+
Description
+
+
+
+
+
namespace
+
object name and auth scope, such as for teams and projects
+
+
+
+
Query Parameters
+
+
+
+
Parameter
+
Description
+
+
+
+
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
pretty
+
If 'true', then the output is pretty printed.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
object name and auth scope, such as for teams and projects
+
rbac
+
v1
+
RoleBinding
-
Query Parameters
+
+
+
+
RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace.
RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch changes to an object of kind Role
+
watch changes to an object of kind RoleBinding
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/roles/{name}
+
GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/rolebindings/{name}
Path Parameters
@@ -55109,7 +56857,7 @@
Path Parameters
name
-
name of the Role
+
name of the RoleBinding
namespace
@@ -55156,7 +56904,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -55179,34 +56927,38 @@
Response
-
Watch List
+
Watch List
kubectl Command
Coming Soon
+
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch individual changes to a list of Role
+
watch individual changes to a list of RoleBinding
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/roles
+
GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/rolebindings
Path Parameters
@@ -55261,7 +57013,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -55284,34 +57036,38 @@
Response
-
Watch List All Namespaces
+
Watch List All Namespaces
kubectl Command
Coming Soon
+
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch individual changes to a list of Role
+
watch individual changes to a list of RoleBinding
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1/watch/roles
+
GET /apis/rbac.authorization.k8s.io/v1/watch/rolebindings
Query Parameters
@@ -55351,7 +57107,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -55375,7 +57131,7 @@
Response
-
RoleBinding v1 rbac
+
SelfSubjectAccessReview v1 authorization
@@ -55386,23 +57142,16 @@
RoleBinding v1 rbac
-
rbac
+
authorization
v1
-
RoleBinding
+
SelfSubjectAccessReview
-
-
-
-
RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace.
-
+
SelfSubjectAccessReview checks whether or the current user can perform an action. Not filling in a spec.namespace means "in all namespaces". Self is a special case, because users should always be able to check whether they can perform an action
RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace. The returned list of actions may be incomplete depending on the server's authorization mode, and any errors experienced during the evaluation. SelfSubjectRulesReview should be used by UIs to show/hide actions, or to quickly let an end user reason about their permissions. It should NOT Be used by external systems to drive authorization decisions as this raises confused deputy, cache lifetime/revocation, and correctness concerns. SubjectAccessReview, and LocalAccessReview are the correct way to defer authorization decisions to the API server.
ServiceAccount binds together: a name, understood by users, and perhaps by peripheral systems, for an identity a principal that can be authenticated and authorized * a set of secrets
AutomountServiceAccountToken indicates whether pods running as this service account should have an API token automatically mounted. Can be overridden at the pod level.
ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. 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.
PUT /api/v1/namespaces/{namespace}/serviceaccounts/{name}
Path Parameters
@@ -55888,6 +57783,10 @@
Path Parameters
+
name
+
name of the ServiceAccount
+
+
namespace
object name and auth scope, such as for teams and projects
@@ -55906,37 +57805,20 @@
Query Parameters
pretty
If 'true', then the output is pretty printed.
+
+
+
Body Parameters
+
+
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
+
Parameter
+
Description
+
+
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
+
+
+
orphanDependents
+
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
+
+
+
propagationPolicy
+
Whether and how garbage collection will be performed. 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.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
list or watch objects of kind RoleBinding
+
read the specified ServiceAccount
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1/rolebindings
-
Query Parameters
+
GET /api/v1/namespaces/{namespace}/serviceaccounts/{name}
+
Path Parameters
@@ -56177,40 +58102,35 @@
Query Parameters
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
+
name
+
name of the ServiceAccount
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
namespace
+
object name and auth scope, such as for teams and projects
+
+
+
Query Parameters
+
+
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
Parameter
+
Description
+
+
pretty
If 'true', then the output is pretty printed.
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
+
exact
+
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
export
+
Should this value be exported. Export strips fields that a user can not specify.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch changes to an object of kind RoleBinding
+
list or watch objects of kind ServiceAccount
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/rolebindings/{name}
+
GET /api/v1/namespaces/{namespace}/serviceaccounts
Path Parameters
@@ -56267,10 +58191,6 @@
Path Parameters
-
name
-
name of the RoleBinding
-
-
namespace
object name and auth scope, such as for teams and projects
@@ -56286,6 +58206,10 @@
Query Parameters
+
pretty
+
If 'true', then the output is pretty printed.
+
+
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.
@@ -56306,16 +58230,12 @@
Query Parameters
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
pretty
-
If 'true', then the output is pretty printed.
-
-
resourceVersion
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
curl Command (requires kubectl proxy to be running)
+
+
+Coming Soon
+
+
+
+
Output
+
+
+Coming Soon
+
+
+
+
Response Body
+
+
+Coming Soon
+
+
+
watch individual changes to a list of ServiceAccount
+
HTTP Request
+
GET /api/v1/watch/namespaces/{namespace}/serviceaccounts
+
Path Parameters
+
+
+
+
Parameter
+
Description
+
+
+
+
+
namespace
+
object name and auth scope, such as for teams and projects
+
+
+
+
Query Parameters
+
+
+
+
Parameter
+
Description
+
+
+
+
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
pretty
+
If 'true', then the output is pretty printed.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
+
+
+Coming Soon
+
+
+
+
Output
+
+
+Coming Soon
+
+
+
+
Response Body
+
+
+Coming Soon
+
+
+
watch individual changes to a list of ServiceAccount
+
HTTP Request
+
GET /api/v1/watch/serviceaccounts
+
Query Parameters
+
+
+
+
Parameter
+
Description
+
+
+
+
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
pretty
+
If 'true', then the output is pretty printed.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -56534,7 +58669,7 @@
Response
-
SelfSubjectAccessReview v1 authorization
+
SubjectAccessReview v1 authorization
@@ -56547,14 +58682,14 @@
SelfSubjectAccessReview v1 aut
authorization
v1
-
SelfSubjectAccessReview
+
SubjectAccessReview
-
+
-
SelfSubjectAccessReview checks whether or the current user can perform an action. Not filling in a spec.namespace means "in all namespaces". Self is a special case, because users should always be able to check whether they can perform an action
+
SubjectAccessReview checks whether or not a user or group can perform an action.
ResourceAuthorizationAttributes describes information for a resource access request
+
+
uid string
+
UID information about the requesting user.
+
+
+
user string
+
User is the user you're testing for. If you specify "User" but not "Groups", then is it interpreted as "What if User were not a member of any groups
+
+
+
+
SubjectAccessReviewStatus v1 authorization
+
+
+
+
+
+
Field
+
Description
+
+
+
+
+
allowed boolean
+
Allowed is required. True if the action would be allowed, false otherwise.
+
+
+
denied boolean
+
Denied is optional. True if the action would be denied, otherwise false. If both allowed is false and denied is false, then the authorizer has no opinion on whether to authorize the action. Denied may not be true if Allowed is true.
+
+
+
evaluationError string
+
EvaluationError is an indication that some error occurred during the authorization check. It is entirely possible to get an error and be able to continue determine authorization status in spite of it. For instance, RBAC can be missing a role, but enough roles are still present and bound to reason about the request.
+
+
+
reason string
+
Reason is optional. It indicates why a request was allowed or denied.
+
-
Write Operations
+
Write Operations
See supported operations below...
-
Create
+
Create
kubectl Command
Coming Soon
+
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
create a SelfSubjectAccessReview
+
create a SubjectAccessReview
HTTP Request
-
POST /apis/authorization.k8s.io/v1/selfsubjectaccessreviews
+
POST /apis/authorization.k8s.io/v1/subjectaccessreviews
SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace. The returned list of actions may be incomplete depending on the server's authorization mode, and any errors experienced during the evaluation. SelfSubjectRulesReview should be used by UIs to show/hide actions, or to quickly let an end user reason about their permissions. It should NOT Be used by external systems to drive authorization decisions as this raises confused deputy, cache lifetime/revocation, and correctness concerns. SubjectAccessReview, and LocalAccessReview are the correct way to defer authorization decisions to the API server.
+
TokenReview attempts to authenticate a token to a known user. Note: TokenReview requests may be cached by the webhook token authenticator plugin in the kube-apiserver.
ServiceAccount binds together: a name, understood by users, and perhaps by peripheral systems, for an identity a principal that can be authenticated and authorized * a set of secrets
+
+
+
+
NetworkPolicy describes what network traffic is allowed for a set of Pods
AutomountServiceAccountToken indicates whether pods running as this service account should have an API token automatically mounted. Can be overridden at the pod level.
ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod
List of egress rules to be applied to the selected pods. Outgoing traffic is allowed if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic matches at least one egress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy limits all outgoing traffic (and serves solely to ensure that the pods it selects are isolated by default). This field is beta-level in 1.8
List of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic source is the pod's local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not allow any traffic (and serves solely to ensure that the pods it selects are isolated by default)
Selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace.
+
+
+
policyTypes string array
+
List of rule types that the NetworkPolicy relates to. Valid options are Ingress, Egress, or Ingress,Egress. If this field is not specified, it will default based on the existence of Ingress or Egress rules; policies that contain an Egress section are assumed to affect Egress, and all policies (whether or not they contain an Ingress section) are assumed to affect Ingress. If you want to write an egress-only policy, you must explicitly specify policyTypes [ "Egress" ]. Likewise, if you want to write a policy that specifies that no egress is allowed, you must specify a policyTypes value that include "Egress" (since such a policy would not include an Egress section and would otherwise default to just [ "Ingress" ]). This field is beta-level in 1.8
a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.
versions are the versions supported in this group.
-
SubjectAccessReviewSpec v1 authorization
+
APIResource v1 meta
+
+
+
+
Group
+
Version
+
Kind
+
+
+
+
+
meta
+
v1
+
APIResource
+
+
+
+
APIResource specifies the name of a resource and whether it is namespaced.
@@ -58089,39 +60413,68 @@
SubjectAccessReviewSpec v1 aut
-
extra object
-
Extra corresponds to the user.Info.GetExtra() method from the authenticator. Since that is input to the authorizer it needs a reflection here.
+
categories string array
+
categories is a list of the grouped resources this resource belongs to (e.g. 'all')
-
groups string array
-
Groups is the groups you're testing for.
+
group string
+
group is the preferred group of the resource. Empty implies the group of the containing resource list. For subresources, this may have a different value, for example: Scale".
ResourceAuthorizationAttributes describes information for a resource access request
+
name string
+
name is the plural name of the resource.
-
uid string
-
UID information about the requesting user.
+
namespaced boolean
+
namespaced indicates if a resource is namespaced or not.
-
user string
-
User is the user you're testing for. If you specify "User" but not "Groups", then is it interpreted as "What if User were not a member of any groups
+
shortNames string array
+
shortNames is a list of suggested short names of the resource.
+
+
+
singularName string
+
singularName is the singular name of the resource. This allows clients to handle plural and singular opaquely. The singularName is more correct for reporting status on a single item and both singular and plural are allowed from the kubectl CLI interface.
+
+
+
verbs string array
+
verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy)
+
+
+
version string
+
version is the preferred version of the resource. Empty implies the version of the containing resource list For subresources, this may have a different value, for example: v1 (while inside a v1beta1 version of the core resource's group)".
-
SubjectAccessReviewStatus v1 authorization
+
APIService v1 apiregistration
+
+
+
+
Group
+
Version
+
Kind
+
+
+
+
+
apiregistration
+
v1
+
APIService
+
+
+
+
+
+
APIService represents a server for a particular GroupVersion. Name must be "version.group".
@@ -58133,108 +60486,86 @@
SubjectAccessReviewStatus v1
-
allowed boolean
-
Allowed is required. True if the action would be allowed, false otherwise.
Denied is optional. True if the action would be denied, otherwise false. If both allowed is false and denied is false, then the authorizer has no opinion on whether to authorize the action. Denied may not be true if Allowed is true.
EvaluationError is an indication that some error occurred during the authorization check. It is entirely possible to get an error and be able to continue determine authorization status in spite of it. For instance, RBAC can be missing a role, but enough roles are still present and bound to reason about the request.
TokenReview attempts to authenticate a token to a known user. Note: TokenReview requests may be cached by the webhook token authenticator plugin in the kube-apiserver.
+
APIVersions lists the versions that are available, to allow clients to discover the API at /api, which is the root path of the legacy v1 API.
a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.
Status is filled in by the server and indicates whether the request can be authenticated.
+
versions string array
+
versions are the api versions that are available.
-
TokenReviewSpec v1 authentication
-
-
+
AWSElasticBlockStoreVolumeSource v1 core
-
Field
-
Description
+
Group
+
Version
+
Kind
-
token string
-
Token is the opaque bearer token.
+
Core
+
v1
+
AWSElasticBlockStoreVolumeSource
-
TokenReviewStatus v1 authentication
+
Represents a Persistent Disk resource in AWS.
+
An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.
@@ -58324,104 +60645,71 @@
TokenReviewStatus v1 authentication
-
authenticated boolean
-
Authenticated indicates that the token was associated with a known user.
-
-
-
error string
-
Error indicates that the token couldn't be checked
+
fsType string
+
Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
User is the UserInfo associated with the provided token.
+
partition integer
+
The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
-
-
-
Write Operations
-
See supported operations below...
-
Create
-
-
kubectl Command
-
-
-Coming Soon
-
-
-
curl Command (requires kubectl proxy to be running)
ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. If any of the selectors match, then the ClusterRole's permissions will be added
List of egress rules to be applied to the selected pods. Outgoing traffic is allowed if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic matches at least one egress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy limits all outgoing traffic (and serves solely to ensure that the pods it selects are isolated by default). This field is beta-level in 1.8
List of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic source is the pod's local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not allow any traffic (and serves solely to ensure that the pods it selects are isolated by default)
Selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace.
+
Group
+
Version
+
Kind
+
+
-
policyTypes string array
-
List of rule types that the NetworkPolicy relates to. Valid options are Ingress, Egress, or Ingress,Egress. If this field is not specified, it will default based on the existence of Ingress or Egress rules; policies that contain an Egress section are assumed to affect Egress, and all policies (whether or not they contain an Ingress section) are assumed to affect Ingress. If you want to write an egress-only policy, you must explicitly specify policyTypes [ "Egress" ]. Likewise, if you want to write a policy that specifies that no egress is allowed, you must specify a policyTypes value that include "Egress" (since such a policy would not include an Egress section and would otherwise default to just [ "Ingress" ]). This field is beta-level in 1.8
+
extensions
+
v1beta1
+
AllowedHostPath
-
NetworkPolicyList v1 networking
+
defines the host volume conditions that will be enabled by a policy for pods to use. It requires the path prefix to be defined.
is the path prefix that the host volume must match. It does not support *. Trailing slashes are trimmed when validating the path prefix with a host path. Examples: /foo would allow /foo, /foo/ and /foo/bar/foo would not allow /food or /etc/foo
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
-
-
-
name
-
name of the NetworkPolicy
+
kind string
+
Expected values Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared
-
namespace
-
object name and auth scope, such as for teams and projects
+
readOnly boolean
+
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
-
Query Parameters
+
AzureFilePersistentVolumeSource v1 core
-
Parameter
-
Description
+
Group
+
Version
+
Kind
-
pretty
-
If 'true', then the output is pretty printed.
+
Core
+
v1
+
AzureFilePersistentVolumeSource
-
Body Parameters
+
AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
ControllerPublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerPublishVolume and ControllerUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
-
-
-
Response
-
-
-
Code
-
Description
+
driver string
+
Driver is the name of the driver to use for this volume. Required.
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
NodeStageSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeStageVolume and NodeStageVolume and NodeUnstageVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
+
+
+
readOnly boolean
+
Optional: The value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write).
+
+
+
volumeAttributes object
+
Attributes of the volume to publish.
+
+
+
volumeHandle string
+
VolumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required.
-
Delete
-
-
kubectl Command
-
-
-Coming Soon
-
-
-
curl Command (requires kubectl proxy to be running)
object name and auth scope, such as for teams and projects
+
Core
+
v1
+
Capabilities
-
Query Parameters
+
Adds and removes POSIX capabilities from running containers.
+
+
-
Parameter
+
Field
Description
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
+
add string array
+
Added capabilities
-
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.
object name and auth scope, such as for teams and projects
+
Core
+
v1
+
CephFSVolumeSource
-
Query Parameters
+
Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.
+
+
-
Parameter
+
Field
Description
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
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.
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
When 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.
human readable message with details about the request state
+
+
+
reason string
+
brief reason for the request state
+
+
+
type string
+
request approval state, currently Approved or Denied.
-
Read Operations
-
See supported operations below...
-
Read
-
-
kubectl Command
-
-
-Coming Soon
-
-
-
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
read the specified NetworkPolicy
-
HTTP Request
-
GET /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}
-
Path Parameters
+
CinderVolumeSource v1 core
-
Parameter
-
Description
+
Group
+
Version
+
Kind
-
name
-
name of the NetworkPolicy
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
+
Core
+
v1
+
CinderVolumeSource
-
Query Parameters
+
Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind NetworkPolicy
-
HTTP Request
-
GET /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies
-
Path Parameters
+
ClientIPConfig represents the configurations of Client IP based session affinity.
+
+
-
Parameter
+
Field
Description
-
namespace
-
object name and auth scope, such as for teams and projects
+
timeoutSeconds integer
+
timeoutSeconds specifies the seconds of ClientIP type session sticky time. The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP". Default value is 10800(for 3 hours).
-
Query Parameters
+
ComponentCondition v1 core
-
Parameter
-
Description
+
Group
+
Version
+
Kind
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
+
Core
+
v1
+
ComponentCondition
+
+
+
Information about the condition of a component.
+
+
+
+
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
Field
+
Description
+
+
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
error string
+
Condition error code for a component. For example, a health check error code.
-
resourceVersion
-
When 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.
+
message string
+
Message about the condition for a component. For example, information about a health check.
-
timeoutSeconds
-
Timeout for the list/watch call.
+
status string
+
Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown".
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
type string
+
Type of condition for a component. Valid value: "Healthy"
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind NetworkPolicy
-
HTTP Request
-
GET /apis/networking.k8s.io/v1/networkpolicies
-
Query Parameters
+
ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.
+
The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.
+
+
-
Parameter
+
Field
Description
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
If true, partially initialized resources are included in the response.
+
optional boolean
+
Specify whether the ConfigMap must be defined
+
+
+
ConfigMapKeySelector v1 core
+
+
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
Group
+
Version
+
Kind
+
+
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
Core
+
v1
+
ConfigMapKeySelector
+
+
+
Selects a key from a ConfigMap.
+
+
+
+
-
pretty
-
If 'true', then the output is pretty printed.
+
Field
+
Description
+
+
-
resourceVersion
-
When 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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind NetworkPolicy
-
HTTP Request
-
GET /apis/networking.k8s.io/v1/watch/namespaces/{namespace}/networkpolicies/{name}
-
Path Parameters
+
Adapts a ConfigMap into a projected volume.
+
The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode.
If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
-
namespace
-
object name and auth scope, such as for teams and projects
Specify whether the ConfigMap or it's keys must be defined
-
Query Parameters
+
ConfigMapVolumeSource v1 core
-
Parameter
-
Description
+
Group
+
Version
+
Kind
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
Core
+
v1
+
ConfigMapVolumeSource
+
+
+
Adapts a ConfigMap into a volume.
+
The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.
+
+
+
+
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
+
Field
+
Description
+
+
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
defaultMode integer
+
Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
When 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.
+
optional boolean
+
Specify whether the ConfigMap or it's keys must be defined
+
+
+
ContainerImage v1 core
+
+
-
timeoutSeconds
-
Timeout for the list/watch call.
+
Group
+
Version
+
Kind
+
+
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
Names by which this image is known. e.g. ["k8s.gcr.io/hyperkube:v1.0.7", "dockerhub.io/google_containers/hyperkube:v1.0.7"]
+
+
+
sizeBytes integer
+
The size of the image in bytes.
-
Watch List
-
-
kubectl Command
-
-
-Coming Soon
-
-
-
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of NetworkPolicy
-
HTTP Request
-
GET /apis/networking.k8s.io/v1/watch/namespaces/{namespace}/networkpolicies
-
Path Parameters
+
ContainerPort v1 core
-
Parameter
-
Description
+
Group
+
Version
+
Kind
-
namespace
-
object name and auth scope, such as for teams and projects
+
Core
+
v1
+
ContainerPort
-
Query Parameters
+
ContainerPort represents a network port in a single container.
+
+
-
Parameter
+
Field
Description
-
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.
+
containerPort integer
+
Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
hostIP string
+
What host IP to bind the external port to.
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
hostPort integer
+
Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.
-
timeoutSeconds
-
Timeout for the list/watch call.
+
name string
+
If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
protocol string
+
Protocol for port. Must be UDP or TCP. Defaults to "TCP".
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch individual changes to a list of NetworkPolicy
-
HTTP Request
-
GET /apis/networking.k8s.io/v1/watch/networkpolicies
-
Query Parameters
+
ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting.
+
+
-
Parameter
+
Field
Description
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
When 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.
a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.
+
reason string
+
(brief) reason from the last termination of the container
Time at which previous execution of the container started
-
APIResource v1 meta
+
ContainerStateWaiting v1 core
@@ -59689,18 +61894,18 @@
APIResource v1 meta
-
meta
+
Core
v1
-
APIResource
+
ContainerStateWaiting
-
APIResource specifies the name of a resource and whether it is namespaced.
+
ContainerStateWaiting is a waiting state of a container.
@@ -59712,44 +61917,16 @@
APIResource v1 meta
-
categories string array
-
categories is a list of the grouped resources this resource belongs to (e.g. 'all')
-
-
-
group string
-
group is the preferred group of the resource. Empty implies the group of the containing resource list. For subresources, this may have a different value, for example: Scale".
-
-
-
kind string
-
kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')
-
-
-
name string
-
name is the plural name of the resource.
-
-
-
namespaced boolean
-
namespaced indicates if a resource is namespaced or not.
-
-
-
shortNames string array
-
shortNames is a list of suggested short names of the resource.
-
-
-
singularName string
-
singularName is the singular name of the resource. This allows clients to handle plural and singular opaquely. The singularName is more correct for reporting status on a single item and both singular and plural are allowed from the kubectl CLI interface.
-
-
-
verbs string array
-
verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy)
+
message string
+
Message regarding why the container is not yet running.
-
version string
-
version is the preferred version of the resource. Empty implies the version of the containing resource list For subresources, this may have a different value, for example: v1 (while inside a v1beta1 version of the core resource's group)".
+
reason string
+
(brief) reason the container is not yet running.
-
APIServiceCondition v1beta1 apiregistration
+
CrossVersionObjectReference v1 autoscaling
@@ -59760,17 +61937,20 @@
APIServiceCondition v1beta1
-
apiregistration
-
v1beta1
-
APIServiceCondition
+
autoscaling
+
v1
+
CrossVersionObjectReference
+
+
+
CrossVersionObjectReference contains enough information to let you identify the referred resource.
a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.
+
reason string
+
Unique, one-word, CamelCase reason for the condition's last transition.
-
versions string array
-
versions are the api versions that are available.
+
status string
+
Status is the status of the condition. Can be True, False, Unknown.
An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.
+
CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition
@@ -59883,24 +62065,32 @@
AWSElasticBlockStoreVolumeSour
-
fsType string
-
Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+
categories string array
+
Categories is a list of grouped resources custom resources belong to (e.g. 'all')
-
partition integer
-
The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
+
kind string
+
Kind is the serialized kind of the resource. It is normally CamelCase and singular.
Plural is the plural name of the resource to serve. It must match the name of the CustomResourceDefinition-registration too: plural.group and it must be all lowercase.
+
+
+
shortNames string array
+
ShortNames are short names for the resource. It must be all lowercase.
+
+
+
singular string
+
Singular is the singular name of the resource. It must be all lowercase Defaults to lowercased <kind>
Describes node affinity scheduling rules for the pod.
+
labelSelectorPath string
+
LabelSelectorPath defines the JSON path inside of a CustomResource that corresponds to Scale.Status.Selector. Only JSON paths without the array notation are allowed. Must be a JSON Path under .status. Must be set to work with HPA. If there is no value under the given path in the CustomResource, the status label selector value in the /scale subresource will default to the empty string.
Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
+
specReplicasPath string
+
SpecReplicasPath defines the JSON path inside of a CustomResource that corresponds to Scale.Spec.Replicas. Only JSON paths without the array notation are allowed. Must be a JSON Path under .spec. If there is no value under the given path in the CustomResource, the /scale subresource will return an error on GET.
Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
+
statusReplicasPath string
+
StatusReplicasPath defines the JSON path inside of a CustomResource that corresponds to Scale.Status.Replicas. Only JSON paths without the array notation are allowed. Must be a JSON Path under .status. If there is no value under the given path in the CustomResource, the status replica value in the /scale subresource will default to 0.
AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole
+
CustomResourceSubresourceStatus defines how to serve the status subresource for CustomResources. Status is represented by the .status JSON path inside of a CustomResource. When set, exposes a /status subresource for the custom resource PUT requests to the /status subresource take a custom resource object, and ignore changes to anything except the status stanza * PUT/POST/PATCH requests to the custom resource ignore changes to the status stanza
ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. If any of the selectors match, then the ClusterRole's permissions will be added
+
-
AllowedFlexVolume v1beta1 extensions
+
CustomResourceSubresources v1beta1 apiextensions
@@ -59999,18 +62186,18 @@
AllowedFlexVolume v1beta1 extensio
-
extensions
+
apiextensions
v1beta1
-
AllowedFlexVolume
+
CustomResourceSubresources
-
AllowedFlexVolume represents a single Flexvolume that is allowed to be used.
+
CustomResourceSubresources defines the status and scale subresources for CustomResources.
Status denotes the status subresource for CustomResources
-
AllowedHostPath v1beta1 extensions
+
CustomResourceValidation v1beta1 apiextensions
@@ -60038,18 +62229,18 @@
AllowedHostPath v1beta1 extensions
-
extensions
+
apiextensions
v1beta1
-
AllowedHostPath
+
CustomResourceValidation
-
defines the host volume conditions that will be enabled by a policy for pods to use. It requires the path prefix to be defined.
+
CustomResourceValidation is a list of validation methods for CustomResources.
@@ -60061,12 +62252,12 @@
AllowedHostPath v1beta1 extensions
-
pathPrefix string
-
is the path prefix that the host volume must match. It does not support *. Trailing slashes are trimmed when validating the path prefix with a host path. Examples: /foo would allow /foo, /foo/ and /foo/bar/foo would not allow /food or /etc/foo
Last time the condition transitioned from one status to another.
-
diskURI string
-
The URI the data disk in the blob storage
+
message string
+
A human readable message indicating details about the transition.
-
fsType string
-
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+
reason string
+
The reason for the condition's last transition.
-
kind string
-
Expected values Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared
+
status string
+
Status of the condition, one of True, False, Unknown.
-
readOnly boolean
-
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+
type string
+
Type of DaemonSet condition.
-
AzureFilePersistentVolumeSource v1 core
+
DaemonSetUpdateStrategy v1 apps
@@ -60180,18 +62364,20 @@
AzureFilePersistentVolumeSource
-
Core
+
apps
v1
-
AzureFilePersistentVolumeSource
+
DaemonSetUpdateStrategy
-
AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
+
+
+
DaemonSetUpdateStrategy is a struct used to control the update strategy for a DaemonSet.
@@ -60203,24 +62389,16 @@
AzureFilePersistentVolumeSource
-
readOnly boolean
-
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
-
-
-
secretName string
-
the name of secret that contains Azure Storage Account Name and Key
-
-
-
secretNamespace string
-
the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod
the name of secret that contains Azure Storage Account Name and Key
+
gracePeriodSeconds integer
+
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.
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.
Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.
+
+
+
propagationPolicy string
+
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.
-
CSIPersistentVolumeSource v1 core
+
DeploymentCondition v1 apps
@@ -60278,18 +62468,20 @@
CSIPersistentVolumeSource v1 core
-
Core
+
apps
v1
-
CSIPersistentVolumeSource
+
DeploymentCondition
-
Represents storage that is managed by an external CSI volume driver
+
+
+
DeploymentCondition describes the state of a deployment at a certain point.
@@ -60301,20 +62493,32 @@
CSIPersistentVolumeSource v1 core
-
driver string
-
Driver is the name of the driver to use for this volume. Required.
VolumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required.
+
message string
+
A human readable message indicating details about the transition.
+
+
+
reason string
+
The reason for the condition's last transition.
+
+
+
status string
+
Status of the condition, one of True, False, Unknown.
+
+
+
type string
+
Type of deployment condition.
-
Capabilities v1 core
+
DownwardAPIProjection v1 core
@@ -60327,16 +62531,16 @@
Capabilities v1 core
Core
v1
-
Capabilities
+
DownwardAPIProjection
-
Adds and removes POSIX capabilities from running containers.
+
Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode.
Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
-
CephFSVolumeSource v1 core
+
DownwardAPIVolumeSource v1 core
@@ -60429,11 +62622,11 @@
CephFSVolumeSource v1 core
Core
v1
-
CephFSVolumeSource
+
DownwardAPIVolumeSource
-
Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.
+
DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.
Last time the condition transitioned from one status to another.
-
failurePolicy string
-
FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Ignore.
+
message string
+
Human-readable message indicating details about last transition.
-
name string
-
The name of the admission webhook. Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where "imagepolicy" is the name of the webhook, and kubernetes.io is the name of the organization. Required.
+
reason string
+
Unique, one-word, CamelCase reason for the condition's last transition.
NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector. If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is other cluster scoped resource, it is not subjected to the webhook. For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": { "matchExpressions": [ { "key": "runlevel", "operator": "NotIn", "values": [ "0", "1" ] } ] } If instead you want to only run the webhook on any objects whose namespace is associated with the "environment" of "prod" or "staging"; you will set the selector as follows: "namespaceSelector": { "matchExpressions": [ { "key": "environment", "operator": "In", "values": [ "prod", "staging" ] } ] } See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ for more examples of label selectors. Default to the empty LabelSelector, which matches everything.
+
status string
+
Status is the status of the condition. Can be True, False, Unknown.
service is a reference to the service for this webhook. Either service or url must be specified. If the webhook is running within the cluster, then you should use service. If there is only one port open for the service, that port will be used. If there are multiple ports open, port 443 will be used if it is open, otherwise it is an error.
-
-
-
url string
-
url gives the location of the webhook, in standard URL form ([scheme://]host:port/path). Exactly one of url or service must be specified. The host should not refer to a service running in the cluster; use the service field instead. The host might be resolved via external DNS in some apiservers (e.g., kube-apiserver cannot resolve in-cluster DNS as that would be a layering violation). host may also be an IP address. Please note that using localhost or 127.0.0.1 as a host is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster. The scheme must be "https"; the URL must begin with "https://". A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier. Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either.
ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. If any of the selectors match, then the ClusterRole's permissions will be added
-
WeightedPodAffinityTerm v1 core
+
+
AggregationRule v1alpha1 rbac
@@ -69719,20 +72179,22 @@
WeightedPodAffinityTerm v1 core
-
Core
-
v1
-
WeightedPodAffinityTerm
+
rbac
+
v1alpha1
+
AggregationRule
-
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
+
+
+
+
AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole
ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. If any of the selectors match, then the ClusterRole's permissions will be added
-
OLD API VERSIONS
-
This section contains older versions of resources shown above.
-
AggregationRule v1beta1 rbac
+
AllowedFlexVolume v1beta1 policy
@@ -69766,21 +72222,18 @@
AggregationRule v1beta1 rbac
-
rbac
+
policy
v1beta1
-
AggregationRule
+
AllowedFlexVolume
-
-
-
-
AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole
+
AllowedFlexVolume represents a single Flexvolume that is allowed to be used.
ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. If any of the selectors match, then the ClusterRole's permissions will be added
+
driver string
+
Driver is the name of the Flexvolume driver.
-
AggregationRule v1alpha1 rbac
+
AllowedHostPath v1beta1 policy
@@ -69809,21 +72262,18 @@
AggregationRule v1alpha1 rbac
-
rbac
-
v1alpha1
-
AggregationRule
+
policy
+
v1beta1
+
AllowedHostPath
-
-
-
-
AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole
+
defines the host volume conditions that will be enabled by a policy for pods to use. It requires the path prefix to be defined.
ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. If any of the selectors match, then the ClusterRole's permissions will be added
+
pathPrefix string
+
is the path prefix that the host volume must match. It does not support *. Trailing slashes are trimmed when validating the path prefix with a host path. Examples: /foo would allow /foo, /foo/ and /foo/bar/foo would not allow /food or /etc/foo
@@ -69926,32 +72376,36 @@
ClusterRoleList v1beta1 rbac
-
Write Operations
+
Write Operations
See supported operations below...
-
Create
+
Create
kubectl Command
Coming Soon
+
curl Command (requires kubectl proxy to be running)
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
delete collection of Deployment
HTTP Request
@@ -84601,7 +87555,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -84624,21 +87578,23 @@
Response
-
Read Operations
+
Read Operations
See supported operations below...
-
Read
+
Read
kubectl Command
$ kubectl get deployment deployment-example -o json
+
curl Command (requires kubectl proxy to be running)
-$ kubectl proxy
-$ curl -X GET http://127.0.0.1:8001/apis/apps/v1beta1/namespaces/default/deployments/deployment-example
+$ kubectl proxy
+$ curl -X GET http://127.0.0.1:8001/apis/apps/v1beta1/namespaces/default/deployments/deployment-example
+
Output
@@ -84713,6 +87669,8 @@
Read
"availableReplicas": 3
}
}
+
+
Response Body
@@ -84787,6 +87745,8 @@
Read
"availableReplicas": 3
}
}
+
+
read the specified Deployment
HTTP Request
@@ -84848,12 +87808,13 @@
Response
-
List
+
List
kubectl Command
$ kubectl get deployment -o json
+
curl Command (requires kubectl proxy to be running)
@@ -84861,6 +87822,7 @@
List
$ kubectl proxy$ curl -X GET 'http://127.0.0.1:8001/apis/apps/v1beta1/namespaces/default/deployments'
+
Output
@@ -85007,6 +87969,8 @@
List
}
]
}
+
+
Response Body
@@ -85153,10 +88117,4579 @@
List
}
]
}
+
+
+
+
list or watch objects of kind Deployment
+
HTTP Request
+
GET /apis/apps/v1beta1/namespaces/{namespace}/deployments
+
Path Parameters
+
+
+
+
Parameter
+
Description
+
+
+
+
+
namespace
+
object name and auth scope, such as for teams and projects
+
+
+
+
Query Parameters
+
+
+
+
Parameter
+
Description
+
+
+
+
+
pretty
+
If 'true', then the output is pretty printed.
+
+
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
+
+
+Coming Soon
+
+
+
+
Output
+
+
+Coming Soon
+
+
+
+
Response Body
+
+
+Coming Soon
+
+
+
list or watch objects of kind Deployment
+
HTTP Request
+
GET /apis/apps/v1beta1/deployments
+
Query Parameters
+
+
+
+
Parameter
+
Description
+
+
+
+
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
pretty
+
If 'true', then the output is pretty printed.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
GET /apis/apps/v1beta1/watch/namespaces/{namespace}/deployments/{name}
+
Path Parameters
+
+
+
+
Parameter
+
Description
+
+
+
+
+
name
+
name of the Deployment
+
+
+
namespace
+
object name and auth scope, such as for teams and projects
+
+
+
+
Query Parameters
+
+
+
+
Parameter
+
Description
+
+
+
+
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
pretty
+
If 'true', then the output is pretty printed.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
+
+
+Coming Soon
+
+
+
+
Output
+
+
+Coming Soon
+
+
+
+
Response Body
+
+
+Coming Soon
+
+
+
watch individual changes to a list of Deployment
+
HTTP Request
+
GET /apis/apps/v1beta1/watch/namespaces/{namespace}/deployments
+
Path Parameters
+
+
+
+
Parameter
+
Description
+
+
+
+
+
namespace
+
object name and auth scope, such as for teams and projects
+
+
+
+
Query Parameters
+
+
+
+
Parameter
+
Description
+
+
+
+
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
pretty
+
If 'true', then the output is pretty printed.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
+
+
+Coming Soon
+
+
+
+
Output
+
+
+Coming Soon
+
+
+
+
Response Body
+
+
+Coming Soon
+
+
+
watch individual changes to a list of Deployment
+
HTTP Request
+
GET /apis/apps/v1beta1/watch/deployments
+
Query Parameters
+
+
+
+
Parameter
+
Description
+
+
+
+
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
pretty
+
If 'true', then the output is pretty printed.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
DEPRECATED - This group version of Deployment is deprecated by apps/v1beta2/Deployment. See the release notes for more information. Deployment enables declarative updates for Pods and ReplicaSets.
Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
+
+
+
paused boolean
+
Indicates that the deployment is paused and will not be processed by the deployment controller.
+
+
+
progressDeadlineSeconds integer
+
The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. This is not set by default.
+
+
+
replicas integer
+
Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
+
+
+
revisionHistoryLimit integer
+
The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified.
Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.
+
+
+
collisionCount integer
+
Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet.
+
+
+
conditions DeploymentCondition array patch type: merge patch merge key: type
+
Represents the latest available observations of a deployment's current state.
+
+
+
observedGeneration integer
+
The generation observed by the deployment controller.
+
+
+
readyReplicas integer
+
Total number of ready pods targeted by this deployment.
+
+
+
replicas integer
+
Total number of non-terminated pods targeted by this deployment (their labels match the selector).
+
+
+
unavailableReplicas integer
+
Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created.
+
+
+
updatedReplicas integer
+
Total number of non-terminated pods targeted by this deployment that have the desired template spec.
The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. By default, a value of 1 is used. Example: when this is set to 30%, the new RC can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new RC can be scaled up further, ensuring that total number of pods running at any time during the update is atmost 130% of desired pods.
+
+
+
maxUnavailable
+
The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. By default, a fixed value of 1 is used. Example: when this is set to 30%, the old RC can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old RC can be scaled down further, followed by scaling up the new RC, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.
object name and auth scope, such as for teams and projects
+
+
+
+
Query Parameters
+
+
+
+
Parameter
+
Description
+
+
+
+
+
pretty
+
If 'true', then the output is pretty printed.
+
+
+
gracePeriodSeconds
+
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
+
+
+
orphanDependents
+
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
+
+
+
propagationPolicy
+
Whether and how garbage collection will be performed. 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.
object name and auth scope, such as for teams and projects
+
+
+
+
Query Parameters
+
+
+
+
Parameter
+
Description
+
+
+
+
+
pretty
+
If 'true', then the output is pretty printed.
+
+
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
GET /apis/extensions/v1beta1/namespaces/{namespace}/deployments
+
Path Parameters
+
+
+
+
Parameter
+
Description
+
+
+
+
+
namespace
+
object name and auth scope, such as for teams and projects
+
+
+
+
Query Parameters
+
+
+
+
Parameter
+
Description
+
+
+
+
+
pretty
+
If 'true', then the output is pretty printed.
+
+
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
+
+
+Coming Soon
+
+
+
+
Output
+
+
+Coming Soon
+
+
+
+
Response Body
+
+
+Coming Soon
+
+
+
list or watch objects of kind Deployment
+
HTTP Request
+
GET /apis/extensions/v1beta1/deployments
+
Query Parameters
+
+
+
+
Parameter
+
Description
+
+
+
+
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
pretty
+
If 'true', then the output is pretty printed.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/deployments/{name}
+
Path Parameters
+
+
+
+
Parameter
+
Description
+
+
+
+
+
name
+
name of the Deployment
+
+
+
namespace
+
object name and auth scope, such as for teams and projects
+
+
+
+
Query Parameters
+
+
+
+
Parameter
+
Description
+
+
+
+
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
pretty
+
If 'true', then the output is pretty printed.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
+
+
+Coming Soon
+
+
+
+
Output
+
+
+Coming Soon
+
+
+
+
Response Body
+
+
+Coming Soon
+
+
+
watch individual changes to a list of Deployment
+
HTTP Request
+
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/deployments
+
Path Parameters
+
+
+
+
Parameter
+
Description
+
+
+
+
+
namespace
+
object name and auth scope, such as for teams and projects
+
+
+
+
Query Parameters
+
+
+
+
Parameter
+
Description
+
+
+
+
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
pretty
+
If 'true', then the output is pretty printed.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
+
+
+Coming Soon
+
+
+
+
Output
+
+
+Coming Soon
+
+
+
+
Response Body
+
+
+Coming Soon
+
+
+
watch individual changes to a list of Deployment
+
HTTP Request
+
GET /apis/extensions/v1beta1/watch/deployments
+
Query Parameters
+
+
+
+
Parameter
+
Description
+
+
+
+
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
pretty
+
If 'true', then the output is pretty printed.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
Optional. A human-readable description of the status of this operation. Maximal length of the note is 1kB, but libraries should be prepared to handle values up to 64kB.
The object this Event is about. In most cases it's an Object reporting controller implements. E.g. ReplicaSetController implements ReplicaSets and this event is emitted because it acts on some changes in a ReplicaSet object.
curl Command (requires kubectl proxy to be running)
+
+
+Coming Soon
+
+
+
+
Output
+
+
+Coming Soon
+
-
list or watch objects of kind Deployment
+
+
Response Body
+
+
+Coming Soon
+
+
+
create an Event
HTTP Request
-
GET /apis/apps/v1beta1/namespaces/{namespace}/deployments
+
POST /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events
Path Parameters
@@ -85185,37 +92718,20 @@
Query Parameters
pretty
If 'true', then the output is pretty printed.
+
+
+
Body Parameters
+
+
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
+
Parameter
+
Description
+
+
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
+
name
+
name of the Event
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
namespace
+
object name and auth scope, such as for teams and projects
+
+
+
Query Parameters
+
+
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
Parameter
+
Description
+
+
pretty
If 'true', then the output is pretty printed.
+
+
+
Body Parameters
+
+
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
+
Parameter
+
Description
+
+
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
GET /apis/apps/v1beta1/watch/namespaces/{namespace}/deployments/{name}
+
PUT /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events/{name}
Path Parameters
@@ -85510,7 +92897,7 @@
Path Parameters
name
-
name of the Deployment
+
name of the Event
namespace
@@ -85528,40 +92915,23 @@
Query Parameters
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
pretty
If 'true', then the output is pretty printed.
+
+
+
Body Parameters
+
+
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
+
Parameter
+
Description
+
+
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
object name and auth scope, such as for teams and projects
@@ -85633,40 +93015,35 @@
Query Parameters
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
pretty
+
If 'true', then the output is pretty printed.
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
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.
-
pretty
-
If 'true', then the output is pretty printed.
+
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.
-
resourceVersion
-
When 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.
+
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.
+
+
+
Body Parameters
+
+
-
timeoutSeconds
-
Timeout for the list/watch call.
+
Parameter
+
Description
+
+
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
object name and auth scope, such as for teams and projects
+
+
+
Query Parameters
@@ -85723,6 +93119,10 @@
Query Parameters
+
pretty
+
If 'true', then the output is pretty printed.
+
+
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.
@@ -85743,16 +93143,12 @@
Query Parameters
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
pretty
-
If 'true', then the output is pretty printed.
-
-
resourceVersion
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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.
-
-
-
Replace Status
-
-
kubectl Command
-
-
-Coming Soon
-
-
-
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
replace status of the specified Deployment
-
HTTP Request
-
PUT /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/status
-
Path Parameters
-
-
-
Parameter
-
Description
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
name
-
name of the Deployment
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
-
namespace
-
object name and auth scope, such as for teams and projects
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
Query Parameters
-
-
-
Parameter
-
Description
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
-
pretty
-
If 'true', then the output is pretty printed.
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
Body Parameters
-
-
-
Parameter
-
Description
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
read scale of the specified Deployment
+
list or watch objects of kind Event
HTTP Request
-
GET /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/scale
-
Path Parameters
+
GET /apis/events.k8s.io/v1beta1/events
+
Query Parameters
@@ -86082,28 +93413,41 @@
Path Parameters
-
name
-
name of the Scale
+
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.
-
namespace
-
object name and auth scope, such as for teams and projects
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
Query Parameters
-
-
-
Parameter
-
Description
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
pretty
If 'true', then the output is pretty printed.
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
replace scale of the specified Deployment
+
watch changes to an object of kind Event
HTTP Request
-
PUT /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/scale
+
GET /apis/events.k8s.io/v1beta1/watch/namespaces/{namespace}/events/{name}
Path Parameters
@@ -86160,7 +93508,7 @@
Path Parameters
name
-
name of the Scale
+
name of the Event
namespace
@@ -86178,23 +93526,40 @@
Query Parameters
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
pretty
If 'true', then the output is pretty printed.
-
-
-
Body Parameters
-
-
-
Parameter
-
Description
+
resourceVersion
+
When 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.
GET /apis/events.k8s.io/v1beta1/watch/namespaces/{namespace}/events
Path Parameters
@@ -86255,10 +93620,6 @@
Path Parameters
-
name
-
name of the Scale
-
-
namespace
object name and auth scope, such as for teams and projects
@@ -86274,23 +93635,40 @@
Query Parameters
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
pretty
If 'true', then the output is pretty printed.
-
-
-
Body Parameters
-
-
-
Parameter
-
Description
+
resourceVersion
+
When 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.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
create rollback of a Deployment
+
watch individual changes to a list of Event
HTTP Request
-
POST /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/rollback
-
Path Parameters
+
GET /apis/events.k8s.io/v1beta1/watch/events
+
Query Parameters
@@ -86347,42 +93729,40 @@
Path Parameters
-
name
-
name of the DeploymentRollback
+
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.
-
namespace
-
object name and auth scope, such as for teams and projects
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
Query Parameters
-
-
-
Parameter
-
Description
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
pretty
If 'true', then the output is pretty printed.
-
-
-
Body Parameters
-
-
-
Parameter
-
Description
+
resourceVersion
+
When 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.
DEPRECATED - This group version of Deployment is deprecated by apps/v1beta2/Deployment. See the release notes for more information. Deployment enables declarative updates for Pods and ReplicaSets.
+
EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time.
Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
-
-
-
paused boolean
-
Indicates that the deployment is paused and will not be processed by the deployment controller.
-
-
-
progressDeadlineSeconds integer
-
The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. This is not set by default.
-
-
-
replicas integer
-
Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
-
-
-
revisionHistoryLimit integer
-
The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified.
HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler, which automatically manages the replica count of any resource implementing the scale subresource based on the metrics specified.
Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.
-
-
-
collisionCount integer
-
Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet.
-
-
-
conditions DeploymentCondition array patch type: merge patch merge key: type
-
Represents the latest available observations of a deployment's current state.
-
-
-
observedGeneration integer
-
The generation observed by the deployment controller.
Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created.
metrics contains the specifications for which to use to calculate the desired replica count (the maximum replica count across all metrics will be used). The desired replica count is calculated multiplying the ratio between the target value and the current value by the current number of pods. Ergo, metrics used must decrease as the pod count is increased, and vice-versa. See the individual metric source types for more information about how each type of metric must respond.
scaleTargetRef points to the target resource to scale, and is used to the pods for which metrics should be collected, as well as to actually change the replica count.
lastScaleTime is the last time the HorizontalPodAutoscaler scaled the number of pods, used by the autoscaler to control how often the number of pods is changed.
-
updatedAnnotations object
-
The annotations to be updated to a deployment
+
observedGeneration integer
+
observedGeneration is the most recent generation observed by this autoscaler.
-
RollingUpdateDeployment v1beta1 extensions
-
-
+
HorizontalPodAutoscalerList v2beta1 autoscaling
@@ -86673,142 +94021,57 @@
RollingUpdateDeployment v1be
-
maxSurge
-
The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. By default, a value of 1 is used. Example: when this is set to 30%, the new RC can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new RC can be scaled up further, ensuring that total number of pods running at any time during the update is atmost 130% of desired pods.
The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. By default, a fixed value of 1 is used. Example: when this is set to 30%, the old RC can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old RC can be scaled down further, followed by scaling up the new RC, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
replace scale of the specified Deployment
-
HTTP Request
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/scale
-
Path Parameters
+
+
IPBlock v1beta1 extensions
-
Parameter
-
Description
+
Group
+
Version
+
Kind
-
name
-
name of the Scale
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
+
extensions
+
v1beta1
+
IPBlock
-
Query Parameters
+
+
+
+
DEPRECATED 1.9 - This group version of IPBlock is deprecated by networking/v1/IPBlock. IPBlock describes a particular CIDR (Ex. "192.168.1.1/24") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.
+
+
-
Parameter
+
Field
Description
-
pretty
-
If 'true', then the output is pretty printed.
+
cidr string
+
CIDR is a string representing the IP Block Valid examples are "192.168.1.1/24"
+
+
+
except string array
+
Except is a slice of CIDRs that should not be included within an IP Block Valid examples are "192.168.1.1/24" Except values will be rejected if they are outside the CIDR range
Name is the identifier of the initializer. It will be added to the object that needs to be initialized. Name should be fully qualified, e.g., alwayspullimages.kubernetes.io, where "alwayspullimages" is the name of the webhook, and kubernetes.io is the name of the organization. Required
Rules describes what resources/subresources the initializer cares about. The initializer cares about an operation if it matches any Rule. Rule.Resources must not include subresources.
-
Patch Scale
-
-
kubectl Command
-
-
-Coming Soon
-
-
-
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
partially update scale of the specified Deployment
LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace. Having a namespace scoped resource makes it much easier to grant namespace scoped policy that includes permissions checking.
Spec holds information about the request being evaluated. spec.namespace must be equal to the namespace you made the request against. If empty, it is defaulted.
A human readable message indicating details about the transition.
-
-
-
reason string
-
The reason for the condition's last transition.
-
-
-
status string
-
Status of the condition, one of True, False, Unknown.
-
-
-
type string
-
Type of deployment condition.
-
-
-
-
-
DeploymentCondition v1beta1 extensions
+
NetworkPolicy v1beta1 extensions
@@ -89384,19 +95841,19 @@
DeploymentCondition v1beta1 exte
extensions
v1beta1
-
DeploymentCondition
+
NetworkPolicy
-
+
-
DeploymentCondition describes the state of a deployment at a certain point.
+
DEPRECATED 1.9 - This group version of NetworkPolicy is deprecated by networking/v1/NetworkPolicy. NetworkPolicy describes what network traffic is allowed for a set of Pods
Optional. A human-readable description of the status of this operation. Maximal length of the note is 1kB, but libraries should be prepared to handle values up to 64kB.
The object this Event is about. In most cases it's an Object reporting controller implements. E.g. ReplicaSetController implements ReplicaSets and this event is emitted because it acts on some changes in a ReplicaSet object.
List of egress rules to be applied to the selected pods. Outgoing traffic is allowed if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic matches at least one egress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy limits all outgoing traffic (and serves solely to ensure that the pods it selects are isolated by default). This field is beta-level in 1.8
List of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod OR if the traffic source is the pod's local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not allow any traffic (and serves solely to ensure that the pods it selects are isolated by default).
Selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace.
-
type string
-
Type of this event (Normal, Warning), new types could be added in the future.
+
policyTypes string array
+
List of rule types that the NetworkPolicy relates to. Valid options are Ingress, Egress, or Ingress,Egress. If this field is not specified, it will default based on the existence of Ingress or Egress rules; policies that contain an Egress section are assumed to affect Egress, and all policies (whether or not they contain an Ingress section) are assumed to affect Ingress. If you want to write an egress-only policy, you must explicitly specify policyTypes [ "Egress" ]. Likewise, if you want to write a policy that specifies that no egress is allowed, you must specify a policyTypes value that include "Egress" (since such a policy would not include an Egress section and would otherwise default to just [ "Ingress" ]). This field is beta-level in 1.8
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch changes to an object of kind Event
+
watch changes to an object of kind NetworkPolicy
HTTP Request
-
GET /apis/events.k8s.io/v1beta1/watch/namespaces/{namespace}/events/{name}
+
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/networkpolicies/{name}
Path Parameters
@@ -90383,7 +96795,7 @@
Path Parameters
name
-
name of the Event
+
name of the NetworkPolicy
namespace
@@ -90430,7 +96842,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -90453,34 +96865,38 @@
Response
-
Watch List
+
Watch List
kubectl Command
Coming Soon
+
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch individual changes to a list of Event
+
watch individual changes to a list of NetworkPolicy
HTTP Request
-
GET /apis/events.k8s.io/v1beta1/watch/namespaces/{namespace}/events
+
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/networkpolicies
Path Parameters
@@ -90535,7 +96951,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -90558,34 +96974,38 @@
Response
-
Watch List All Namespaces
+
Watch List All Namespaces
kubectl Command
Coming Soon
+
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch individual changes to a list of Event
+
watch individual changes to a list of NetworkPolicy
HTTP Request
-
GET /apis/events.k8s.io/v1beta1/watch/events
+
GET /apis/extensions/v1beta1/watch/networkpolicies
Query Parameters
@@ -90625,7 +97045,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -90649,7 +97069,7 @@
Response
-
EventSeries v1beta1 events
+
NetworkPolicyEgressRule v1beta1 extensions
@@ -90660,21 +97080,21 @@
EventSeries v1beta1 events
-
events
+
extensions
v1beta1
-
EventSeries
+
NetworkPolicyEgressRule
-
+
-
EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time.
+
DEPRECATED 1.9 - This group version of NetworkPolicyEgressRule is deprecated by networking/v1/NetworkPolicyEgressRule. NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. This type is beta-level in 1.8
@@ -90686,21 +97106,17 @@
EventSeries v1beta1 events
-
count integer
-
Number of occurrences in this series up to the last heartbeat time
List of destination ports for outgoing traffic. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.
-
state string
-
Information whether this series is ongoing or finished.
List of destinations for outgoing traffic of pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all destinations (traffic not restricted by destination). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the to list.
-
HorizontalPodAutoscaler v2beta1 autoscaling
+
NetworkPolicyIngressRule v1beta1 extensions
@@ -90711,21 +97127,21 @@
HorizontalPodAutoscaler v2b
-
autoscaling
-
v2beta1
-
HorizontalPodAutoscaler
+
extensions
+
v1beta1
+
NetworkPolicyIngressRule
-
+
-
HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler, which automatically manages the replica count of any resource implementing the scale subresource based on the metrics specified.
+
DEPRECATED 1.9 - This group version of NetworkPolicyIngressRule is deprecated by networking/v1/NetworkPolicyIngressRule. This NetworkPolicyIngressRule matches traffic if and only if the traffic matches both ports AND from.
List of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all sources (traffic not restricted by source). If this field is present and contains at least on item, this rule allows traffic only if the traffic matches at least one item in the from list.
List of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.
-
HorizontalPodAutoscalerSpec v2beta1 autoscaling
-
-
+
+
NetworkPolicyPeer v1beta1 extensions
-
Field
-
Description
+
Group
+
Version
+
Kind
-
maxReplicas integer
-
maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas.
metrics contains the specifications for which to use to calculate the desired replica count (the maximum replica count across all metrics will be used). The desired replica count is calculated multiplying the ratio between the target value and the current value by the current number of pods. Ergo, metrics used must decrease as the pod count is increased, and vice-versa. See the individual metric source types for more information about how each type of metric must respond.
-
-
-
minReplicas integer
-
minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod.
scaleTargetRef points to the target resource to scale, and is used to the pods for which metrics should be collected, as well as to actually change the replica count.
+
extensions
+
v1beta1
+
NetworkPolicyPeer
-
HorizontalPodAutoscalerStatus v2beta1 autoscaling
+
+
+
+
DEPRECATED 1.9 - This group version of NetworkPolicyPeer is deprecated by networking/v1/NetworkPolicyPeer.
lastScaleTime is the last time the HorizontalPodAutoscaler scaled the number of pods, used by the autoscaler to control how often the number of pods is changed.
-
-
-
observedGeneration integer
-
observedGeneration is the most recent generation observed by this autoscaler.
Selects Namespaces using cluster scoped-labels. This matches all pods in all namespaces selected by this label selector. This field follows standard label selector semantics. If present but empty, this selector selects all namespaces.
This is a label selector which selects Pods in this namespace. This field follows standard label selector semantics. If present but empty, this selector selects all pods in this namespace.
If specified, the port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched.
object name and auth scope, such as for teams and projects
+
authorization
+
v1beta1
+
NonResourceAttributes
-
Query Parameters
+
+
+
+
NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface
+
+
-
Parameter
+
Field
Description
-
pretty
-
If 'true', then the output is pretty printed.
+
path string
+
Path is the URL path of the request
-
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.
+
verb string
+
Verb is the standard HTTP verb
+
+
+
+
NonResourceRule v1beta1 authorization
+
+
-
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.
+
Group
+
Version
+
Kind
+
+
-
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.
+
authorization
+
v1beta1
+
NonResourceRule
-
Body Parameters
+
+
+
+
NonResourceRule holds information that describes a rule for the non-resource
AllowPrivilegeEscalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true.
-
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.
+
allowedCapabilities string array
+
AllowedCapabilities is a list of capabilities that can be requested to add to the container. Capabilities in this field may be added at the pod author's discretion. You must not list a capability in both AllowedCapabilities and RequiredDropCapabilities.
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
AllowedFlexVolumes is a whitelist of allowed Flexvolumes. Empty or nil indicates that all Flexvolumes may be used. This parameter is effective only when the usage of the Flexvolumes is allowed in the "Volumes" field.
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
is a white list of allowed host paths. Empty indicates that all host paths may be used.
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
defaultAddCapabilities string array
+
DefaultAddCapabilities is the default set of capabilities that will be added to the container unless the pod spec specifically drops the capability. You may not list a capability in both DefaultAddCapabilities and RequiredDropCapabilities. Capabilities added here are implicitly allowed, and need not be included in the AllowedCapabilities list.
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
defaultAllowPrivilegeEscalation boolean
+
DefaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process.
-
resourceVersion
-
When 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.
hostPorts determines which host port ranges are allowed to be exposed.
+
+
+
privileged boolean
+
privileged determines if a pod can request to be run as privileged.
+
+
+
readOnlyRootFilesystem boolean
+
ReadOnlyRootFilesystem when set to true will force containers to run with a read only root file system. If the container specifically requests to run with a non-read only root file system the PSP should deny the pod. If set to false the container may run with a read only root file system if it wishes but it will not be forced to.
+
+
+
requiredDropCapabilities string array
+
RequiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added.
object name and auth scope, such as for teams and projects
+
name
+
name of the PodSecurityPolicy
@@ -91499,37 +97673,20 @@
Query Parameters
pretty
If 'true', then the output is pretty printed.
+
+
+
Body Parameters
+
+
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
+
Parameter
+
Description
+
+
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
list or watch objects of kind HorizontalPodAutoscaler
+
replace the specified PodSecurityPolicy
HTTP Request
-
GET /apis/autoscaling/v2beta1/horizontalpodautoscalers
-
Query Parameters
+
PUT /apis/policy/v1beta1/podsecuritypolicies/{name}
+
Path Parameters
@@ -91586,40 +97747,38 @@
Query Parameters
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
name
+
name of the PodSecurityPolicy
+
+
+
Query Parameters
+
+
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
Parameter
+
Description
+
+
pretty
If 'true', then the output is pretty printed.
+
+
+
Body Parameters
+
+
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
+
Parameter
+
Description
+
+
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
object name and auth scope, such as for teams and projects
+
name of the PodSecurityPolicy
@@ -91695,40 +97858,35 @@
Query Parameters
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
pretty
+
If 'true', then the output is pretty printed.
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
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.
-
pretty
-
If 'true', then the output is pretty printed.
+
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.
-
resourceVersion
-
When 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.
+
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.
+
+
+
Body Parameters
+
+
-
timeoutSeconds
-
Timeout for the list/watch call.
+
Parameter
+
Description
+
+
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch individual changes to a list of HorizontalPodAutoscaler
+
delete collection of PodSecurityPolicy
HTTP Request
-
GET /apis/autoscaling/v2beta1/watch/namespaces/{namespace}/horizontalpodautoscalers
-
Path Parameters
+
DELETE /apis/policy/v1beta1/podsecuritypolicies
+
Query Parameters
@@ -91785,20 +97947,9 @@
Path Parameters
-
namespace
-
object name and auth scope, such as for teams and projects
-
-
-
-
Query Parameters
-
-
-
-
Parameter
-
Description
+
pretty
+
If 'true', then the output is pretty printed.
-
-
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.
@@ -91820,16 +97971,12 @@
Query Parameters
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
pretty
-
If 'true', then the output is pretty printed.
-
-
resourceVersion
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch individual changes to a list of HorizontalPodAutoscaler
+
read the specified PodSecurityPolicy
HTTP Request
-
GET /apis/autoscaling/v2beta1/watch/horizontalpodautoscalers
-
Query Parameters
+
GET /apis/policy/v1beta1/podsecuritypolicies/{name}
+
Path Parameters
@@ -91890,40 +98043,31 @@
Query Parameters
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
name
+
name of the PodSecurityPolicy
+
+
+
Query Parameters
+
+
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
Parameter
+
Description
+
+
pretty
If 'true', then the output is pretty printed.
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
+
exact
+
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
export
+
Should this value be exported. Export strips fields that a user can not specify.
object name and auth scope, such as for teams and projects
+
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.
-
-
-
Query Parameters
-
-
-
Parameter
-
Description
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
pretty
-
If 'true', then the output is pretty printed.
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
-
-
-
Body Parameters
-
-
-
Parameter
-
Description
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
read status of the specified HorizontalPodAutoscaler
+
watch changes to an object of kind PodSecurityPolicy
HTTP Request
-
GET /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
+
GET /apis/policy/v1beta1/watch/podsecuritypolicies/{name}
Path Parameters
@@ -92075,11 +98223,7 @@
Path Parameters
name
-
name of the HorizontalPodAutoscaler
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
+
name of the PodSecurityPolicy
@@ -92093,9 +98237,41 @@
Query Parameters
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
pretty
If 'true', then the output is pretty printed.
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
replace status of the specified HorizontalPodAutoscaler
+
watch individual changes to a list of PodSecurityPolicy
HTTP Request
-
PUT /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
-
Path Parameters
+
GET /apis/policy/v1beta1/watch/podsecuritypolicies
+
Query Parameters
@@ -92151,42 +98331,40 @@
Path Parameters
-
name
-
name of the HorizontalPodAutoscaler
+
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.
-
namespace
-
object name and auth scope, such as for teams and projects
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
Query Parameters
-
-
-
Parameter
-
Description
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
pretty
If 'true', then the output is pretty printed.
-
-
-
Body Parameters
-
-
-
Parameter
-
Description
+
resourceVersion
+
When 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.
DEPRECATED 1.9 - This group version of IPBlock is deprecated by networking/v1/IPBlock. IPBlock describes a particular CIDR (Ex. "192.168.1.1/24") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.
+
PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.
@@ -92247,17 +98422,29 @@
IPBlock v1beta1 extensions
-
cidr string
-
CIDR is a string representing the IP Block Valid examples are "192.168.1.1/24"
+
apiGroups string array
+
APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed.
-
except string array
-
Except is a slice of CIDRs that should not be included within an IP Block Valid examples are "192.168.1.1/24" Except values will be rejected if they are outside the CIDR range
+
nonResourceURLs string array
+
NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.
+
+
+
resourceNames string array
+
ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
+
+
+
resources string array
+
Resources is a list of resources this rule applies to. '' represents all resources in the specified apiGroups. '/foo' represents the subresource 'foo' for all resources in the specified apiGroups.
+
+
+
verbs string array
+
Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.
-
Initializer v1alpha1 admissionregistration
+
PolicyRule v1alpha1 rbac
@@ -92268,21 +98455,22 @@
Initializer v1alpha1 admissi
-
admissionregistration
+
rbac
v1alpha1
-
Initializer
+
PolicyRule
-
+
-
Initializer describes the name and the failure policy of an initializer, and what resources it applies to.
+
PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.
@@ -92294,64 +98482,29 @@
Initializer v1alpha1 admissi
-
name string
-
Name is the identifier of the initializer. It will be added to the object that needs to be initialized. Name should be fully qualified, e.g., alwayspullimages.kubernetes.io, where "alwayspullimages" is the name of the webhook, and kubernetes.io is the name of the organization. Required
Rules describes what resources/subresources the initializer cares about. The initializer cares about an operation if it matches any Rule. Rule.Resources must not include subresources.
-
-
-
-
-
JobTemplateSpec v2alpha1 batch
-
-
-
-
Group
-
Version
-
Kind
+
apiGroups string array
+
APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed.
-
-
-
batch
-
v2alpha1
-
JobTemplateSpec
+
nonResourceURLs string array
+
NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path This name is intentionally different than the internal type so that the DefaultConvert works nicely and because the ordering may be different. Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.
-
-
-
-
-
-
JobTemplateSpec describes the data a Job should have when created from a template
-
-
-
-
-
Field
-
Description
+
resourceNames string array
+
ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.
-
LocalSubjectAccessReview v1beta1 authorization
+
ReplicaSet v1beta2 apps
@@ -92362,16 +98515,23 @@
LocalSubjectAccessReview
-
authorization
-
v1beta1
-
LocalSubjectAccessReview
+
apps
+
v1beta2
+
ReplicaSet
-
+
-
LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace. Having a namespace scoped resource makes it much easier to grant namespace scoped policy that includes permissions checking.
+
DEPRECATED - This group version of ReplicaSet is deprecated by apps/v1/ReplicaSet. See the release notes for more information. ReplicaSet ensures that a specified number of pod replicas are running at any given time.
Spec holds information about the request being evaluated. spec.namespace must be equal to the namespace you made the request against. If empty, it is defaulted.
DEPRECATED 1.9 - This group version of NetworkPolicy is deprecated by networking/v1/NetworkPolicy. NetworkPolicy describes what network traffic is allowed for a set of Pods
Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
List of egress rules to be applied to the selected pods. Outgoing traffic is allowed if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic matches at least one egress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy limits all outgoing traffic (and serves solely to ensure that the pods it selects are isolated by default). This field is beta-level in 1.8
+
availableReplicas integer
+
The number of available replicas (ready for at least minReadySeconds) for this replica set.
List of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod OR if the traffic source is the pod's local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not allow any traffic (and serves solely to ensure that the pods it selects are isolated by default).
+
conditions ReplicaSetCondition array patch type: merge patch merge key: type
+
Represents the latest available observations of a replica set's current state.
Selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace.
+
fullyLabeledReplicas integer
+
The number of pods that have labels matching the labels of the pod template of the replicaset.
-
policyTypes string array
-
List of rule types that the NetworkPolicy relates to. Valid options are Ingress, Egress, or Ingress,Egress. If this field is not specified, it will default based on the existence of Ingress or Egress rules; policies that contain an Egress section are assumed to affect Egress, and all policies (whether or not they contain an Ingress section) are assumed to affect Ingress. If you want to write an egress-only policy, you must explicitly specify policyTypes [ "Egress" ]. Likewise, if you want to write a policy that specifies that no egress is allowed, you must specify a policyTypes value that include "Egress" (since such a policy would not include an Egress section and would otherwise default to just [ "Ingress" ]). This field is beta-level in 1.8
+
observedGeneration integer
+
ObservedGeneration reflects the generation of the most recently observed ReplicaSet.
+
+
+
readyReplicas integer
+
The number of ready replicas for this replica set.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch changes to an object of kind NetworkPolicy
+
watch changes to an object of kind ReplicaSet
HTTP Request
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/networkpolicies/{name}
+
GET /apis/apps/v1beta2/watch/namespaces/{namespace}/replicasets/{name}
Path Parameters
@@ -93432,7 +99517,7 @@
Path Parameters
name
-
name of the NetworkPolicy
+
name of the ReplicaSet
namespace
@@ -93479,7 +99564,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -93502,34 +99587,38 @@
Response
-
Watch List
+
Watch List
kubectl Command
Coming Soon
+
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch individual changes to a list of NetworkPolicy
+
watch individual changes to a list of ReplicaSet
HTTP Request
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/networkpolicies
+
GET /apis/apps/v1beta2/watch/namespaces/{namespace}/replicasets
Path Parameters
@@ -93584,7 +99673,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -93607,34 +99696,38 @@
Response
-
Watch List All Namespaces
+
Watch List All Namespaces
kubectl Command
Coming Soon
+
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch individual changes to a list of NetworkPolicy
+
watch individual changes to a list of ReplicaSet
HTTP Request
-
GET /apis/extensions/v1beta1/watch/networkpolicies
+
GET /apis/apps/v1beta2/watch/replicasets
Query Parameters
@@ -93674,7 +99767,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -93697,607 +99790,319 @@
Response
-
-
NetworkPolicyEgressRule v1beta1 extensions
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
extensions
-
v1beta1
-
NetworkPolicyEgressRule
-
-
-
-
-
-
-
DEPRECATED 1.9 - This group version of NetworkPolicyEgressRule is deprecated by networking/v1/NetworkPolicyEgressRule. NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. This type is beta-level in 1.8
List of destination ports for outgoing traffic. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.
List of destinations for outgoing traffic of pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all destinations (traffic not restricted by destination). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the to list.
-
-
-
-
-
NetworkPolicyIngressRule v1beta1 extensions
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
extensions
-
v1beta1
-
NetworkPolicyIngressRule
-
-
-
-
-
-
-
DEPRECATED 1.9 - This group version of NetworkPolicyIngressRule is deprecated by networking/v1/NetworkPolicyIngressRule. This NetworkPolicyIngressRule matches traffic if and only if the traffic matches both ports AND from.
List of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all sources (traffic not restricted by source). If this field is present and contains at least on item, this rule allows traffic only if the traffic matches at least one item in the from list.
List of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.
-
-
-
-
-
NetworkPolicyPeer v1beta1 extensions
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
extensions
-
v1beta1
-
NetworkPolicyPeer
-
-
-
-
-
-
-
DEPRECATED 1.9 - This group version of NetworkPolicyPeer is deprecated by networking/v1/NetworkPolicyPeer.
Selects Namespaces using cluster scoped-labels. This matches all pods in all namespaces selected by this label selector. This field follows standard label selector semantics. If present but empty, this selector selects all namespaces.
This is a label selector which selects Pods in this namespace. This field follows standard label selector semantics. If present but empty, this selector selects all pods in this namespace.
-
-
-
-
-
NetworkPolicyPort v1beta1 extensions
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
extensions
-
v1beta1
-
NetworkPolicyPort
-
-
-
-
+
Status Operations
+
See supported operations below...
+
Patch Status
+
+
kubectl Command
+
+
+Coming Soon
+
+
+
curl Command (requires kubectl proxy to be running)
+
+
+Coming Soon
-
DEPRECATED 1.9 - This group version of NetworkPolicyPort is deprecated by networking/v1/NetworkPolicyPort.
If specified, the port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched.
-
-
-
protocol string
-
Optional. The protocol (TCP or UDP) which traffic must match. If not specified, this field defaults to TCP.
-
-
-
-
-
NonResourceAttributes v1beta1 authorization
-
-
-
-
Group
-
Version
-
Kind
+
name
+
name of the ReplicaSet
-
-
-
authorization
-
v1beta1
-
NonResourceAttributes
+
namespace
+
object name and auth scope, such as for teams and projects
-
-
-
-
NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface
-
-
+
Query Parameters
-
Field
+
Parameter
Description
-
path string
-
Path is the URL path of the request
-
-
-
verb string
-
Verb is the standard HTTP verb
-
-
-
-
-
NonResourceRule v1beta1 authorization
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
authorization
-
v1beta1
-
NonResourceRule
+
pretty
+
If 'true', then the output is pretty printed.
-
-
-
-
NonResourceRule holds information that describes a rule for the non-resource
-
-
+
Body Parameters
-
Field
+
Parameter
Description
-
nonResourceURLs string array
-
NonResourceURLs is a set of partial urls that a user should have access to. s are allowed, but only as the full, final step in the path. "" means all.
-
-
-
verbs string array
-
Verb is a list of kubernetes non-resource API verbs, like: get, post, put, delete, patch, head, options. "*" means all.
PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.
-
-
+
Response
-
Field
+
Code
Description
-
apiGroups string array
-
APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed.
-
-
-
nonResourceURLs string array
-
NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.
-
-
-
resourceNames string array
-
ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
-
-
-
resources string array
-
Resources is a list of resources this rule applies to. '' represents all resources in the specified apiGroups. '/foo' represents the subresource 'foo' for all resources in the specified apiGroups.
-
-
-
verbs string array
-
Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.
curl Command (requires kubectl proxy to be running)
+
+
+Coming Soon
-
PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.
GET /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}/status
+
Path Parameters
-
Field
+
Parameter
Description
-
apiGroups string array
-
APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed.
-
-
-
nonResourceURLs string array
-
NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path This name is intentionally different than the internal type so that the DefaultConvert works nicely and because the ordering may be different. Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.
+
name
+
name of the ReplicaSet
-
resourceNames string array
-
ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
+
namespace
+
object name and auth scope, such as for teams and projects
+
+
+
Query Parameters
+
+
-
resources string array
-
Resources is a list of resources this rule applies to. ResourceAll represents all resources.
+
Parameter
+
Description
+
+
-
verbs string array
-
Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.
curl Command (requires kubectl proxy to be running)
+
+
+Coming Soon
-
DEPRECATED - This group version of ReplicaSet is deprecated by apps/v1/ReplicaSet. See the release notes for more information. ReplicaSet ensures that a specified number of pod replicas are running at any given time.
object name and auth scope, such as for teams and projects
-
ReplicaSetSpec v1beta2 apps
-
-
+
Query Parameters
-
Field
+
Parameter
Description
-
minReadySeconds integer
-
Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
DEPRECATED - This group version of ReplicaSet is deprecated by apps/v1beta2/ReplicaSet. See the release notes for more information. ReplicaSet ensures that a specified number of pod replicas are running at any given time.
Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
POST /apis/extensions/v1beta1/namespaces/{namespace}/replicasets
Path Parameters
@@ -94592,10 +100554,6 @@
Path Parameters
-
name
-
name of the ReplicaSet
-
-
namespace
object name and auth scope, such as for teams and projects
@@ -94614,18 +100572,6 @@
Query Parameters
pretty
If 'true', then the output is pretty printed.
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. 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.
object name and auth scope, such as for teams and projects
@@ -94714,37 +100676,20 @@
Query Parameters
pretty
If 'true', then the output is pretty printed.
+
+
+
Body Parameters
+
+
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
+
Parameter
+
Description
+
+
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
object name and auth scope, such as for teams and projects
@@ -94907,36 +100873,31 @@
Query Parameters
If 'true', then the output is pretty printed.
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
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.
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
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.
-
resourceVersion
-
When 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.
+
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.
+
+
+
Body Parameters
+
+
-
timeoutSeconds
-
Timeout for the list/watch call.
+
Parameter
+
Description
+
+
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
object name and auth scope, such as for teams and projects
+
+
+
Query Parameters
@@ -94993,6 +100973,10 @@
Query Parameters
+
pretty
+
If 'true', then the output is pretty printed.
+
+
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.
@@ -95013,16 +100997,12 @@
Query Parameters
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
pretty
-
If 'true', then the output is pretty printed.
-
-
resourceVersion
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch changes to an object of kind ReplicaSet
+
read the specified ReplicaSet
HTTP Request
-
GET /apis/apps/v1beta2/watch/namespaces/{namespace}/replicasets/{name}
+
GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}
Path Parameters
@@ -95102,40 +101088,16 @@
Query Parameters
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
pretty
If 'true', then the output is pretty printed.
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
+
exact
+
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
export
+
Should this value be exported. Export strips fields that a user can not specify.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch individual changes to a list of ReplicaSet
+
list or watch objects of kind ReplicaSet
HTTP Request
-
GET /apis/apps/v1beta2/watch/namespaces/{namespace}/replicasets
+
GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets
Path Parameters
@@ -95207,6 +101173,10 @@
Query Parameters
+
pretty
+
If 'true', then the output is pretty printed.
+
+
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.
@@ -95227,16 +101197,12 @@
Query Parameters
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
pretty
-
If 'true', then the output is pretty printed.
-
-
resourceVersion
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/replicasets/{name}
Path Parameters
@@ -95408,100 +101380,40 @@
Query Parameters
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
-
Body Parameters
-
-
-
-
Parameter
-
Description
+
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.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
Read Status
-
-
kubectl Command
-
-
-Coming Soon
-
-
-
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
read status of the specified ReplicaSet
-
HTTP Request
-
GET /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}/status
-
Path Parameters
-
-
-
Parameter
-
Description
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
-
name
-
name of the ReplicaSet
+
pretty
+
If 'true', then the output is pretty printed.
-
namespace
-
object name and auth scope, such as for teams and projects
+
resourceVersion
+
When 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.
-
-
-
Query Parameters
-
-
-
Parameter
-
Description
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
-
-
-
pretty
-
If 'true', then the output is pretty printed.
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
replace status of the specified ReplicaSet
+
watch individual changes to a list of ReplicaSet
HTTP Request
-
PUT /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}/status
+
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/replicasets
Path Parameters
@@ -95558,10 +101474,6 @@
Path Parameters
-
name
-
name of the ReplicaSet
-
-
namespace
object name and auth scope, such as for teams and projects
@@ -95577,23 +101489,40 @@
Query Parameters
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
pretty
If 'true', then the output is pretty printed.
-
-
-
Body Parameters
-
-
-
Parameter
-
Description
+
resourceVersion
+
When 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.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
read scale of the specified ReplicaSet
+
watch individual changes to a list of ReplicaSet
HTTP Request
-
GET /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}/scale
-
Path Parameters
+
GET /apis/extensions/v1beta1/watch/replicasets
+
Query Parameters
@@ -95656,28 +101583,41 @@
Path Parameters
-
name
-
name of the Scale
+
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.
-
namespace
-
object name and auth scope, such as for teams and projects
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
Query Parameters
-
-
-
Parameter
-
Description
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
pretty
If 'true', then the output is pretty printed.
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
DEPRECATED - This group version of ReplicaSet is deprecated by apps/v1beta2/ReplicaSet. See the release notes for more information. ReplicaSet ensures that a specified number of pod replicas are running at any given time.
Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. 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.
object name and auth scope, such as for teams and projects
+
apps
+
v1beta2
+
ReplicaSetCondition
-
Query Parameters
+
+
+
+
ReplicaSetCondition describes the state of a replica set at a certain point.
+
+
-
Parameter
+
Field
Description
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
-
resourceVersion
-
When 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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind ReplicaSet
-
HTTP Request
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets
-
Path Parameters
+
+
ResourceAttributes v1beta1 authorization
-
Parameter
-
Description
+
Group
+
Version
+
Kind
-
namespace
-
object name and auth scope, such as for teams and projects
+
authorization
+
v1beta1
+
ResourceAttributes
-
Query Parameters
+
+
+
+
ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface
+
+
-
Parameter
+
Field
Description
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
group string
+
Group is the API Group of the Resource. "*" means all.
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
+
name string
+
Name is the name of the resource being requested for a "get" or deleted for a "delete". "" (empty) means all.
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
namespace string
+
Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces "" (empty) is defaulted for LocalSubjectAccessReviews "" (empty) is empty for cluster-scoped resources "" (empty) means "all" for namespace scoped resources from a SubjectAccessReview or SelfSubjectAccessReview
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
resource string
+
Resource is one of the existing resource types. "*" means all.
-
resourceVersion
-
When 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.
+
subresource string
+
Subresource is one of the existing resource types. "" means none.
-
timeoutSeconds
-
Timeout for the list/watch call.
+
verb string
+
Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all.
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
version string
+
Version is the API Version of the Resource. "*" means all.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind ReplicaSet
-
HTTP Request
-
GET /apis/extensions/v1beta1/replicasets
-
Query Parameters
+
+
+
+
ResourceRule is the list of actions the subject is allowed to perform on resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.
+
+
-
Parameter
+
Field
Description
-
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.
+
apiGroups string array
+
APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "*" means all.
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
resourceNames string array
+
ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. "*" means all.
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
+
resources string array
+
Resources is a list of resources this rule applies to. "" means all in the specified apiGroups. "/foo" represents the subresource 'foo' for all resources in the specified apiGroups.
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
verbs string array
+
Verb is a list of kubernetes resource API verbs, like: get, list, watch, create, update, delete, proxy. "*" means all.
+
+
+
+
+
Role v1beta1 rbac
+
+
+
+
Group
+
Version
+
Kind
+
+
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
rbac
+
v1beta1
+
Role
+
+
+
+
+
+
Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding.
+
+
+
+
-
pretty
-
If 'true', then the output is pretty printed.
+
Field
+
Description
+
+
-
resourceVersion
-
When 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.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch changes to an object of kind ReplicaSet
+
create a Role
HTTP Request
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/replicasets/{name}
+
POST /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles
Path Parameters
@@ -96860,10 +102560,6 @@
Path Parameters
-
name
-
name of the ReplicaSet
-
-
namespace
object name and auth scope, such as for teams and projects
@@ -96879,40 +102575,23 @@
Query Parameters
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
pretty
If 'true', then the output is pretty printed.
+
+
+
Body Parameters
+
+
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
+
Parameter
+
Description
+
+
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
object name and auth scope, such as for teams and projects
@@ -96984,40 +102679,23 @@
Query Parameters
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
pretty
If 'true', then the output is pretty printed.
+
+
+
Body Parameters
+
+
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
+
Parameter
+
Description
+
+
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch individual changes to a list of ReplicaSet
+
replace the specified Role
HTTP Request
-
GET /apis/extensions/v1beta1/watch/replicasets
-
Query Parameters
+
PUT /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name}
+
Path Parameters
@@ -97074,40 +102756,42 @@
Query Parameters
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
+
name
+
name of the Role
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
namespace
+
object name and auth scope, such as for teams and projects
+
+
+
Query Parameters
+
+
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
Parameter
+
Description
+
+
pretty
If 'true', then the output is pretty printed.
+
+
+
Body Parameters
+
+
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
+
Parameter
+
Description
+
+
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
+
+
+
orphanDependents
+
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
+
+
+
propagationPolicy
+
Whether and how garbage collection will be performed. 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.
object name and auth scope, such as for teams and projects
@@ -97280,6 +102982,38 @@
Query Parameters
pretty
If 'true', then the output is pretty printed.
+
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
read scale of the specified ReplicaSet
+
list or watch objects of kind Role
HTTP Request
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/scale
+
GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles
Path Parameters
@@ -97433,10 +103156,6 @@
Path Parameters
-
name
-
name of the Scale
-
-
namespace
object name and auth scope, such as for teams and projects
@@ -97455,6 +103174,38 @@
Query Parameters
pretty
If 'true', then the output is pretty printed.
+
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
replace scale of the specified ReplicaSet
+
list or watch objects of kind Role
HTTP Request
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/scale
-
Path Parameters
+
GET /apis/rbac.authorization.k8s.io/v1beta1/roles
+
Query Parameters
@@ -97510,42 +103265,40 @@
Path Parameters
-
name
-
name of the Scale
+
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.
-
namespace
-
object name and auth scope, such as for teams and projects
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
Query Parameters
-
-
-
Parameter
-
Description
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
pretty
If 'true', then the output is pretty printed.
-
-
-
Body Parameters
-
-
-
Parameter
-
Description
+
resourceVersion
+
When 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.
GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/roles/{name}
Path Parameters
@@ -97607,7 +103360,7 @@
Path Parameters
name
-
name of the Scale
+
name of the Role
namespace
@@ -97625,23 +103378,40 @@
Query Parameters
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
pretty
If 'true', then the output is pretty printed.
-
-
-
Body Parameters
-
-
-
Parameter
-
Description
+
resourceVersion
+
When 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.
The last time the condition transitioned from one status to another.
-
-
-
message string
-
A human readable message indicating details about the transition.
-
-
-
reason string
-
The reason for the condition's last transition.
-
-
-
status string
-
Status of the condition, one of True, False, Unknown.
-
-
-
type string
-
Type of replica set condition.
+
namespace
+
object name and auth scope, such as for teams and projects
-
-
ReplicaSetCondition v1beta1 extensions
+
Query Parameters
-
Group
-
Version
-
Kind
+
Parameter
+
Description
-
extensions
-
v1beta1
-
ReplicaSetCondition
+
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.
-
-
-
-
-
-
ReplicaSetCondition describes the state of a replica set at a certain point.
-
-
-
-
-
Field
-
Description
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
The last time the condition transitioned from one status to another.
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
-
message string
-
A human readable message indicating details about the transition.
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
reason string
-
The reason for the condition's last transition.
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
status string
-
Status of the condition, one of True, False, Unknown.
+
pretty
+
If 'true', then the output is pretty printed.
-
type string
-
Type of replica set condition.
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
GET /apis/rbac.authorization.k8s.io/v1beta1/watch/roles
+
Query Parameters
-
Field
+
Parameter
Description
-
group string
-
Group is the API Group of the Resource. "*" means all.
+
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.
-
name string
-
Name is the name of the resource being requested for a "get" or deleted for a "delete". "" (empty) means all.
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
namespace string
-
Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces "" (empty) is defaulted for LocalSubjectAccessReviews "" (empty) is empty for cluster-scoped resources "" (empty) means "all" for namespace scoped resources from a SubjectAccessReview or SelfSubjectAccessReview
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
-
resource string
-
Resource is one of the existing resource types. "*" means all.
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
subresource string
-
Subresource is one of the existing resource types. "" means none.
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
verb string
-
Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all.
+
pretty
+
If 'true', then the output is pretty printed.
-
version string
-
Version is the API Version of the Resource. "*" means all.
+
resourceVersion
+
When 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.
-
-
-
-
ResourceRule v1beta1 authorization
-
-
-
Group
-
Version
-
Kind
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
-
-
-
authorization
-
v1beta1
-
ResourceRule
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
-
-
-
-
ResourceRule is the list of actions the subject is allowed to perform on resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.
-
-
+
Response
-
Field
+
Code
Description
-
apiGroups string array
-
APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "*" means all.
-
-
-
resourceNames string array
-
ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. "*" means all.
-
-
-
resources string array
-
Resources is a list of resources this rule applies to. "" means all in the specified apiGroups. "/foo" represents the subresource 'foo' for all resources in the specified apiGroups.
-
-
-
verbs string array
-
Verb is a list of kubernetes resource API verbs, like: get, list, watch, create, update, delete, proxy. "*" means all.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
watch changes to an object of kind Role
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/roles/{name}
+
GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/roles/{name}
Path Parameters
@@ -98838,7 +104606,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -98861,34 +104629,38 @@
Response
-
Watch List
+
Watch List
kubectl Command
Coming Soon
+
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
watch individual changes to a list of Role
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/roles
+
GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/roles
Path Parameters
@@ -98943,7 +104715,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -98966,34 +104738,38 @@
Response
-
Watch List All Namespaces
+
Watch List All Namespaces
kubectl Command
Coming Soon
+
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
watch individual changes to a list of Role
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1beta1/watch/roles
+
GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/roles
Query Parameters
@@ -99033,7 +104809,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -99057,7 +104833,7 @@
Response
-
Role v1alpha1 rbac
+
RoleBinding v1beta1 rbac
@@ -99069,20 +104845,20 @@
Role v1alpha1 rbac
rbac
-
v1alpha1
-
Role
+
v1beta1
+
RoleBinding
-
+
-
Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding.
+
RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace.
RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch changes to an object of kind Role
+
watch changes to an object of kind RoleBinding
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/roles/{name}
+
GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/rolebindings/{name}
Path Parameters
@@ -99946,7 +105762,7 @@
Path Parameters
name
-
name of the Role
+
name of the RoleBinding
namespace
@@ -99993,7 +105809,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -100016,34 +105832,38 @@
Response
-
Watch List
+
Watch List
kubectl Command
Coming Soon
+
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch individual changes to a list of Role
+
watch individual changes to a list of RoleBinding
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/roles
+
GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/rolebindings
Path Parameters
@@ -100098,7 +105918,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -100121,34 +105941,38 @@
Response
-
Watch List All Namespaces
+
Watch List All Namespaces
kubectl Command
Coming Soon
+
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch individual changes to a list of Role
+
watch individual changes to a list of RoleBinding
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/roles
+
GET /apis/rbac.authorization.k8s.io/v1beta1/watch/rolebindings
Query Parameters
@@ -100188,7 +106012,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -100212,7 +106036,7 @@
Response
-
RoleBinding v1beta1 rbac
+
RoleBinding v1alpha1 rbac
@@ -100224,12 +106048,12 @@
RoleBinding v1beta1 rbac
rbac
-
v1beta1
+
v1alpha1
RoleBinding
-
+
RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace.
RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
watch changes to an object of kind RoleBinding
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/rolebindings/{name}
+
GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/rolebindings/{name}
Path Parameters
@@ -101152,7 +107012,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -101175,34 +107035,38 @@
Response
-
Watch List
+
Watch List
kubectl Command
Coming Soon
+
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
watch individual changes to a list of RoleBinding
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/rolebindings
+
GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/rolebindings
Path Parameters
@@ -101257,7 +107121,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -101280,34 +107144,38 @@
Response
-
Watch List All Namespaces
+
Watch List All Namespaces
kubectl Command
Coming Soon
+
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
watch individual changes to a list of RoleBinding
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1beta1/watch/rolebindings
+
GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/rolebindings
Query Parameters
@@ -101347,7 +107215,7 @@
Query Parameters
timeoutSeconds
-
Timeout for the list/watch call.
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch
@@ -101371,7 +107239,59 @@
Response
-
RoleBinding v1alpha1 rbac
+
RoleRef v1beta1 rbac
+
+
+
+
Group
+
Version
+
Kind
+
+
+
+
+
rbac
+
v1beta1
+
RoleRef
+
+
+
+
+
+
+
RoleRef contains information that points to the role being used
+
+
+
+
+
+
Field
+
Description
+
+
+
+
+
apiGroup string
+
APIGroup is the group for the resource being referenced
+
+
+
kind string
+
Kind is the type of resource being referenced
+
+
+
name string
+
Name is the name of resource being referenced
+
+
+
+
+
RoleRef v1alpha1 rbac
@@ -101384,21 +107304,281 @@
RoleBinding v1alpha1 rbac
rbac
v1alpha1
-
RoleBinding
+
RoleRef
-
+
-
RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace.
+
RoleRef contains information that points to the role being used
+
+
+
+
+
Field
+
Description
+
+
+
+
+
apiGroup string
+
APIGroup is the group for the resource being referenced
+
+
+
kind string
+
Kind is the type of resource being referenced
+
+
+
name string
+
Name is the name of resource being referenced
+
+
+
+
+
RollbackConfig v1beta1 extensions
+
+
+
+
Group
+
Version
+
Kind
+
+
+
+
+
extensions
+
v1beta1
+
RollbackConfig
+
+
+
+
DEPRECATED.
+
+
+
+
+
+
Field
+
Description
+
+
+
+
+
revision integer
+
The revision to rollback to. If set to 0, rollback to the last revision.
+
+
+
+
+
RollingUpdateStatefulSetStrategy v1beta2 apps
+
+
+
+
Group
+
Version
+
Kind
+
+
+
+
+
apps
+
v1beta2
+
RollingUpdateStatefulSetStrategy
+
+
+
+
+
+
+
RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.
+
+
+
+
+
+
Field
+
Description
+
+
+
+
+
partition integer
+
Partition indicates the ordinal at which the StatefulSet should be partitioned. Default value is 0.
+
+
+
+
+
RollingUpdateStatefulSetStrategy v1beta1 apps
+
+
+
+
Group
+
Version
+
Kind
+
+
+
+
+
apps
+
v1beta1
+
RollingUpdateStatefulSetStrategy
+
+
+
+
+
+
+
RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.
+
+
+
+
+
+
Field
+
Description
+
+
+
+
+
partition integer
+
Partition indicates the ordinal at which the StatefulSet should be partitioned.
+
+
+
+
+
RunAsUserStrategyOptions v1beta1 policy
+
+
+
+
Group
+
Version
+
Kind
+
+
+
+
+
policy
+
v1beta1
+
RunAsUserStrategyOptions
+
+
+
+
Run A sUser Strategy Options defines the strategy type and any options used to create the strategy.
RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
label selector for pods that should match the replicas count. This is a serializated version of both map-based and more expressive set-based selectors. This is done to avoid introspection in the clients. The string will be in the same format as the query-param syntax. If the target type only supports map-based selectors, both this field and map-based selector field are populated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
+
+
+
+
+
Scale v1beta1 apps
+
+
+
+
Group
+
Version
+
Kind
+
+
+
+
+
apps
+
v1beta1
+
Scale
+
+
+
+
+
+
+
Scale represents a scaling request for a resource.
label selector for pods that should match the replicas count. This is a serializated version of both map-based and more expressive set-based selectors. This is done to avoid introspection in the clients. The string will be in the same format as the query-param syntax. If the target type only supports map-based selectors, both this field and map-based selector field are populated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
label selector for pods that should match the replicas count. This is a serializated version of both map-based and more expressive set-based selectors. This is done to avoid introspection in the clients. The string will be in the same format as the query-param syntax. If the target type only supports map-based selectors, both this field and map-based selector field are populated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
-
Query Parameters
+
+
SelfSubjectAccessReview v1beta1 authorization
-
Parameter
-
Description
+
Group
+
Version
+
Kind
-
pretty
-
If 'true', then the output is pretty printed.
+
authorization
+
v1beta1
+
SelfSubjectAccessReview
-
Body Parameters
+
+
+
+
SelfSubjectAccessReview checks whether or the current user can perform an action. Not filling in a spec.namespace means "in all namespaces". Self is a special case, because users should always be able to check whether they can perform an action
object name and auth scope, such as for teams and projects
+
authorization
+
v1beta1
+
SelfSubjectRulesReview
-
Query Parameters
+
+
+
+
SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace. The returned list of actions may be incomplete depending on the server's authorization mode, and any errors experienced during the evaluation. SelfSubjectRulesReview should be used by UIs to show/hide actions, or to quickly let an end user reason about their permissions. It should NOT Be used by external systems to drive authorization decisions as this raises confused deputy, cache lifetime/revocation, and correctness concerns. SubjectAccessReview, and LocalAccessReview are the correct way to defer authorization decisions to the API server.
-
Parameter
+
Field
Description
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
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.
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.
POST /apis/authorization.k8s.io/v1beta1/selfsubjectrulesreviews
+
Query Parameters
@@ -101884,12 +108152,12 @@
Path Parameters
-
namespace
-
object name and auth scope, such as for teams and projects
+
pretty
+
If 'true', then the output is pretty printed.
-
Query Parameters
+
Body Parameters
@@ -101899,360 +108167,361 @@
Query Parameters
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
Code
+
Description
+
+
-
resourceVersion
-
When 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.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind RoleBinding
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings
-
Path Parameters
+
+
StatefulSet v1beta2 apps
-
Parameter
-
Description
+
Group
+
Version
+
Kind
-
namespace
-
object name and auth scope, such as for teams and projects
+
apps
+
v1beta2
+
StatefulSet
-
Query Parameters
+
+
+
+
DEPRECATED - This group version of StatefulSet is deprecated by apps/v1/StatefulSet. See the release notes for more information. StatefulSet represents a set of pods with consistent identities. Identities are defined as:
+
+
Network: A single stable DNS and hostname.
+
Storage: As many VolumeClaims as requested.
+The StatefulSet guarantees that a given network identity will always map to the same storage identity.
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.
Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time.
+
+
+
StatefulSetSpec v1beta2 apps
+
+
+
+
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
Field
+
Description
+
+
-
resourceVersion
-
When 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.
+
podManagementPolicy string
+
podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is OrderedReady, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is Parallel which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.
-
timeoutSeconds
-
Timeout for the list/watch call.
+
replicas integer
+
replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
revisionHistoryLimit integer
+
revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.
serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller.
template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet.
volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.
-
List All Namespaces
-
-
kubectl Command
-
-
-Coming Soon
-
-
-
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind RoleBinding
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1alpha1/rolebindings
-
Query Parameters
+
StatefulSetStatus v1beta2 apps
+
+
-
Parameter
+
Field
Description
-
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.
+
collisionCount integer
+
collisionCount is the count of hash collisions for the StatefulSet. The StatefulSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
Represents the latest available observations of a statefulset's current state.
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
+
currentReplicas integer
+
currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision.
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
currentRevision string
+
currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas).
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
observedGeneration integer
+
observedGeneration is the most recent generation observed for this StatefulSet. It corresponds to the StatefulSet's generation, which is updated on mutation by the API Server.
-
pretty
-
If 'true', then the output is pretty printed.
+
readyReplicas integer
+
readyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition.
-
resourceVersion
-
When 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.
+
replicas integer
+
replicas is the number of Pods created by the StatefulSet controller.
-
timeoutSeconds
-
Timeout for the list/watch call.
+
updateRevision string
+
updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [replicas-updatedReplicas,replicas)
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
updatedReplicas integer
+
updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch changes to an object of kind RoleBinding
+
create a StatefulSet
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/rolebindings/{name}
+
POST /apis/apps/v1beta2/namespaces/{namespace}/statefulsets
Path Parameters
@@ -102263,10 +108532,6 @@
Path Parameters
-
name
-
name of the RoleBinding
-
-
namespace
object name and auth scope, such as for teams and projects
@@ -102282,40 +108547,23 @@
Query Parameters
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
pretty
If 'true', then the output is pretty printed.
+
+
+
Body Parameters
+
+
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
+
Parameter
+
Description
+
+
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
object name and auth scope, such as for teams and projects
@@ -102387,40 +108651,23 @@
Query Parameters
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
pretty
If 'true', then the output is pretty printed.
+
+
+
Body Parameters
+
+
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
+
Parameter
+
Description
+
+
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
-
-Coming Soon
-
-
watch individual changes to a list of RoleBinding
-
HTTP Request
-
GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/rolebindings
-
Query Parameters
-
-
-
-
Parameter
-
Description
-
-
-
-
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
-
-
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
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.
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.
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.
-
ScaleSpec v1beta2 apps
-
-
+
Body Parameters
-
Field
+
Parameter
Description
-
replicas integer
-
desired number of instances for the scaled object.
label selector for pods that should match the replicas count. This is a serializated version of both map-based and more expressive set-based selectors. This is done to avoid introspection in the clients. The string will be in the same format as the query-param syntax. If the target type only supports map-based selectors, both this field and map-based selector field are populated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
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.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
-
ScaleSpec v1beta1 apps
-
-
+
Response
-
Field
+
Code
Description
-
replicas integer
-
desired number of instances for the scaled object.
label selector for pods that should match the replicas count. This is a serializated version of both map-based and more expressive set-based selectors. This is done to avoid introspection in the clients. The string will be in the same format as the query-param syntax. If the target type only supports map-based selectors, both this field and map-based selector field are populated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
-
-
-
-
-
Scale v1beta1 extensions
-
-
-
-
Group
-
Version
-
Kind
+
name
+
name of the StatefulSet
-
-
-
extensions
-
v1beta1
-
Scale
+
namespace
+
object name and auth scope, such as for teams and projects
label selector for pods that should match the replicas count. This is a serializated version of both map-based and more expressive set-based selectors. This is done to avoid introspection in the clients. The string will be in the same format as the query-param syntax. If the target type only supports map-based selectors, both this field and map-based selector field are populated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
+
namespace
+
object name and auth scope, such as for teams and projects
-
-
SelfSubjectAccessReview v1beta1 authorization
+
Query Parameters
-
Group
-
Version
-
Kind
+
Parameter
+
Description
-
authorization
-
v1beta1
-
SelfSubjectAccessReview
+
pretty
+
If 'true', then the output is pretty printed.
-
-
-
-
-
-
SelfSubjectAccessReview checks whether or the current user can perform an action. Not filling in a spec.namespace means "in all namespaces". Self is a special case, because users should always be able to check whether they can perform an action
-
-
-
Field
-
Description
+
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.
Spec holds information about the request being evaluated. user and groups must be empty
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
Status is filled in by the server and indicates whether the request is allowed or not
+
resourceVersion
+
When 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.
-
-
-
SelfSubjectAccessReviewSpec v1beta1 authorization
-
-
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
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.
-
-
-
-
SelfSubjectRulesReview v1beta1 authorization
-
-
-
Group
-
Version
-
Kind
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
authorization
-
v1beta1
-
SelfSubjectRulesReview
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
-
-
-
-
-
-
SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace. The returned list of actions may be incomplete depending on the server's authorization mode, and any errors experienced during the evaluation. SelfSubjectRulesReview should be used by UIs to show/hide actions, or to quickly let an end user reason about their permissions. It should NOT Be used by external systems to drive authorization decisions as this raises confused deputy, cache lifetime/revocation, and correctness concerns. SubjectAccessReview, and LocalAccessReview are the correct way to defer authorization decisions to the API server.
-
-
-
Field
-
Description
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
When 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.
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.
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
-
ServiceReference v1beta1 apiregistration
-
-
-
Group
-
Version
-
Kind
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
-
-
-
apiregistration
-
v1beta1
-
ServiceReference
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
ServiceReference holds a reference to Service.legacy.k8s.io
-
-
-
-
-
Field
-
Description
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
-
name string
-
Name is the name of the service
+
pretty
+
If 'true', then the output is pretty printed.
-
namespace string
-
Namespace is the namespace of the service
+
resourceVersion
+
When 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.
-
-
-
-
StatefulSet v1beta2 apps
-
-
-
Group
-
Version
-
Kind
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
-
-
-
apps
-
v1beta2
-
StatefulSet
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
-
-
-
-
DEPRECATED - This group version of StatefulSet is deprecated by apps/v1/StatefulSet. See the release notes for more information. StatefulSet represents a set of pods with consistent identities. Identities are defined as:
-
-
Network: A single stable DNS and hostname.
-
Storage: As many VolumeClaims as requested.
-The StatefulSet guarantees that a given network identity will always map to the same storage identity.
curl Command (requires kubectl proxy to be running)
+
+
+Coming Soon
+
+
+
+
Output
+
+
+Coming Soon
+
+
+
+
Response Body
+
+
+Coming Soon
+
+
watch individual changes to a list of StatefulSet
+
HTTP Request
+
GET /apis/apps/v1beta2/watch/namespaces/{namespace}/statefulsets
+
Path Parameters
-
Field
+
Parameter
Description
-
podManagementPolicy string
-
podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is OrderedReady, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is Parallel which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.
-
-
-
replicas integer
-
replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.
-
-
-
revisionHistoryLimit integer
-
revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.
serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller.
template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet.
volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.
+
namespace
+
object name and auth scope, such as for teams and projects
-
StatefulSetStatus v1beta2 apps
-
-
+
Query Parameters
-
Field
+
Parameter
Description
-
collisionCount integer
-
collisionCount is the count of hash collisions for the StatefulSet. The StatefulSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.
+
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.
Represents the latest available observations of a statefulset's current state.
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
currentReplicas integer
-
currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision.
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
-
currentRevision string
-
currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas).
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
observedGeneration integer
-
observedGeneration is the most recent generation observed for this StatefulSet. It corresponds to the StatefulSet's generation, which is updated on mutation by the API Server.
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
readyReplicas integer
-
readyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition.
+
pretty
+
If 'true', then the output is pretty printed.
-
replicas integer
-
replicas is the number of Pods created by the StatefulSet controller.
+
resourceVersion
+
When 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.
-
updateRevision string
-
updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [replicas-updatedReplicas,replicas)
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
-
updatedReplicas integer
-
updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision.
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
create a StatefulSet
+
watch individual changes to a list of StatefulSet
HTTP Request
-
POST /apis/apps/v1beta2/namespaces/{namespace}/statefulsets
-
Path Parameters
+
GET /apis/apps/v1beta2/watch/statefulsets
+
Query Parameters
@@ -103669,38 +109561,40 @@
Path Parameters
-
namespace
-
object name and auth scope, such as for teams and projects
+
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.
-
-
-
Query Parameters
-
-
-
Parameter
-
Description
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
pretty
If 'true', then the output is pretty printed.
-
-
-
Body Parameters
-
-
-
Parameter
-
Description
+
resourceVersion
+
When 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.
PUT /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}/status
Path Parameters
@@ -103975,18 +109856,6 @@
Query Parameters
pretty
If 'true', then the output is pretty printed.
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. 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.
GET /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}/scale
Path Parameters
@@ -104057,6 +109936,10 @@
Path Parameters
+
name
+
name of the Scale
+
+
namespace
object name and auth scope, such as for teams and projects
@@ -104075,38 +109958,6 @@
Query Parameters
pretty
If 'true', then the output is pretty printed.
-
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
-
-
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
object name and auth scope, such as for teams and projects
@@ -104267,173 +110139,267 @@
Query Parameters
pretty
If 'true', then the output is pretty printed.
+
+
+
Body Parameters
+
+
-
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.
+
Parameter
+
Description
+
+
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
Group
+
Version
+
Kind
+
+
-
resourceVersion
-
When 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.
+
apps
+
v1beta1
+
StatefulSet
+
+
+
+
+
+
+
DEPRECATED - This group version of StatefulSet is deprecated by apps/v1beta2/StatefulSet. See the release notes for more information. StatefulSet represents a set of pods with consistent identities. Identities are defined as:
+
+
Network: A single stable DNS and hostname.
+
Storage: As many VolumeClaims as requested.
+The StatefulSet guarantees that a given network identity will always map to the same storage identity.
podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is OrderedReady, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is Parallel which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.
+
+
+
replicas integer
+
replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.
+
+
+
revisionHistoryLimit integer
+
revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.
serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller.
template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet.
volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.
-
List All Namespaces
-
-
kubectl Command
-
-
-Coming Soon
-
-
-
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind StatefulSet
-
HTTP Request
-
GET /apis/apps/v1beta2/statefulsets
-
Query Parameters
+
StatefulSetStatus v1beta1 apps
+
+
-
Parameter
+
Field
Description
-
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.
+
collisionCount integer
+
collisionCount is the count of hash collisions for the StatefulSet. The StatefulSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
Represents the latest available observations of a statefulset's current state.
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
+
currentReplicas integer
+
currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision.
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
currentRevision string
+
currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas).
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
observedGeneration integer
+
observedGeneration is the most recent generation observed for this StatefulSet. It corresponds to the StatefulSet's generation, which is updated on mutation by the API Server.
-
pretty
-
If 'true', then the output is pretty printed.
+
readyReplicas integer
+
readyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition.
-
resourceVersion
-
When 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.
+
replicas integer
+
replicas is the number of Pods created by the StatefulSet controller.
-
timeoutSeconds
-
Timeout for the list/watch call.
+
updateRevision string
+
updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [replicas-updatedReplicas,replicas)
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
updatedReplicas integer
+
updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch changes to an object of kind StatefulSet
+
create a StatefulSet
HTTP Request
-
GET /apis/apps/v1beta2/watch/namespaces/{namespace}/statefulsets/{name}
+
POST /apis/apps/v1beta1/namespaces/{namespace}/statefulsets
Path Parameters
@@ -104444,10 +110410,6 @@
Path Parameters
-
name
-
name of the StatefulSet
-
-
namespace
object name and auth scope, such as for teams and projects
@@ -104463,40 +110425,23 @@
Query Parameters
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
pretty
If 'true', then the output is pretty printed.
+
+
+
Body Parameters
+
+
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
+
Parameter
+
Description
+
+
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
object name and auth scope, such as for teams and projects
@@ -104568,40 +110529,23 @@
Query Parameters
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
pretty
If 'true', then the output is pretty printed.
+
+
+
Body Parameters
+
+
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
+
Parameter
+
Description
+
+
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch individual changes to a list of StatefulSet
+
replace the specified StatefulSet
HTTP Request
-
GET /apis/apps/v1beta2/watch/statefulsets
-
Query Parameters
+
PUT /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}
+
Path Parameters
@@ -104658,40 +110606,42 @@
Query Parameters
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
+
name
+
name of the StatefulSet
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
namespace
+
object name and auth scope, such as for teams and projects
+
+
+
Query Parameters
+
+
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
Parameter
+
Description
+
+
pretty
If 'true', then the output is pretty printed.
+
+
+
Body Parameters
+
+
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
+
Parameter
+
Description
+
+
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
+
+
+
orphanDependents
+
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
+
+
+
propagationPolicy
+
Whether and how garbage collection will be performed. 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.
object name and auth scope, such as for teams and projects
@@ -104864,6 +110832,38 @@
Query Parameters
pretty
If 'true', then the output is pretty printed.
+
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
read scale of the specified StatefulSet
+
list or watch objects of kind StatefulSet
HTTP Request
-
GET /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}/scale
+
GET /apis/apps/v1beta1/namespaces/{namespace}/statefulsets
Path Parameters
@@ -105017,10 +111014,6 @@
Path Parameters
-
name
-
name of the Scale
-
-
namespace
object name and auth scope, such as for teams and projects
@@ -105039,6 +111032,38 @@
Query Parameters
pretty
If 'true', then the output is pretty printed.
+
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
replace scale of the specified StatefulSet
+
list or watch objects of kind StatefulSet
HTTP Request
-
PUT /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}/scale
-
Path Parameters
+
GET /apis/apps/v1beta1/statefulsets
+
Query Parameters
@@ -105094,42 +111123,40 @@
Path Parameters
-
name
-
name of the Scale
+
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.
-
namespace
-
object name and auth scope, such as for teams and projects
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
Query Parameters
-
-
-
Parameter
-
Description
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
pretty
If 'true', then the output is pretty printed.
-
-
-
Body Parameters
-
-
-
Parameter
-
Description
+
resourceVersion
+
When 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.
GET /apis/apps/v1beta1/watch/namespaces/{namespace}/statefulsets/{name}
Path Parameters
@@ -105191,7 +111218,7 @@
Path Parameters
name
-
name of the Scale
+
name of the StatefulSet
namespace
@@ -105209,23 +111236,40 @@
Query Parameters
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
pretty
If 'true', then the output is pretty printed.
-
-
-
Body Parameters
-
-
-
Parameter
-
Description
+
resourceVersion
+
When 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.
curl Command (requires kubectl proxy to be running)
+
+
+Coming Soon
-
DEPRECATED - This group version of StatefulSet is deprecated by apps/v1beta2/StatefulSet. See the release notes for more information. StatefulSet represents a set of pods with consistent identities. Identities are defined as:
-
-
Network: A single stable DNS and hostname.
-
Storage: As many VolumeClaims as requested.
-The StatefulSet guarantees that a given network identity will always map to the same storage identity.
Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time.
+
namespace
+
object name and auth scope, such as for teams and projects
-
StatefulSetSpec v1beta1 apps
-
-
+
Query Parameters
-
Field
+
Parameter
Description
-
podManagementPolicy string
-
podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is OrderedReady, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is Parallel which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.
+
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.
-
replicas integer
-
replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
revisionHistoryLimit integer
-
revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
serviceName string
-
serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller.
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet.
updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.
+
resourceVersion
+
When 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.
volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
-
StatefulSetStatus v1beta1 apps
-
-
+
Response
-
Field
+
Code
Description
-
collisionCount integer
-
collisionCount is the count of hash collisions for the StatefulSet. The StatefulSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.
curl Command (requires kubectl proxy to be running)
+
+
+Coming Soon
+
+
+
+
Output
+
+
+Coming Soon
+
+
+
+
Response Body
+
+
+Coming Soon
+
+
+
watch individual changes to a list of StatefulSet
+
HTTP Request
+
GET /apis/apps/v1beta1/watch/statefulsets
+
Query Parameters
+
+
-
currentReplicas integer
-
currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision.
+
Parameter
+
Description
+
+
-
currentRevision string
-
currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas).
+
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.
-
observedGeneration integer
-
observedGeneration is the most recent generation observed for this StatefulSet. It corresponds to the StatefulSet's generation, which is updated on mutation by the API Server.
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
readyReplicas integer
-
readyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition.
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
-
replicas integer
-
replicas is the number of Pods created by the StatefulSet controller.
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
updateRevision string
-
updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [replicas-updatedReplicas,replicas)
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
updatedReplicas integer
-
updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision.
+
pretty
+
If 'true', then the output is pretty printed.
-
-
-
StatefulSetList v1beta1 apps
-
-
-
Field
-
Description
+
resourceVersion
+
When 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.
GET /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/scale
Path Parameters
@@ -105764,7 +111815,7 @@
Path Parameters
name
-
name of the StatefulSet
+
name of the Scale
namespace
@@ -105785,33 +111836,6 @@
Query Parameters
pretty
If 'true', then the output is pretty printed.
-
-
gracePeriodSeconds
-
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-
-
-
orphanDependents
-
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-
-
-
propagationPolicy
-
Whether and how garbage collection will be performed. 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.
PUT /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/scale
Path Parameters
@@ -105867,6 +111895,10 @@
Path Parameters
+
name
+
name of the Scale
+
+
namespace
object name and auth scope, such as for teams and projects
@@ -105885,37 +111917,20 @@
Query Parameters
pretty
If 'true', then the output is pretty printed.
+
+
+
Body Parameters
+
+
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
+
Parameter
+
Description
+
+
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind StatefulSet
-
HTTP Request
-
GET /apis/apps/v1beta1/namespaces/{namespace}/statefulsets
-
Path Parameters
+
+
StatefulSetCondition v1beta2 apps
-
Parameter
-
Description
+
Group
+
Version
+
Kind
-
namespace
-
object name and auth scope, such as for teams and projects
+
apps
+
v1beta2
+
StatefulSetCondition
-
Query Parameters
+
+
+
+
StatefulSetCondition describes the state of a statefulset at a certain point.
+
+
-
Parameter
+
Field
Description
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
Last time the condition transitioned from one status to another.
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
message string
+
A human readable message indicating details about the transition.
-
resourceVersion
-
When 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.
+
reason string
+
The reason for the condition's last transition.
-
timeoutSeconds
-
Timeout for the list/watch call.
+
status string
+
Status of the condition, one of True, False, Unknown.
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
list or watch objects of kind StatefulSet
-
HTTP Request
-
GET /apis/apps/v1beta1/statefulsets
-
Query Parameters
+
+
+
+
StatefulSetCondition describes the state of a statefulset at a certain point.
+
+
-
Parameter
+
Field
Description
-
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.
Last time the condition transitioned from one status to another.
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
message string
+
A human readable message indicating details about the transition.
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
+
reason string
+
The reason for the condition's last transition.
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
status string
+
Status of the condition, one of True, False, Unknown.
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
type string
+
Type of statefulset condition.
+
+
+
+
StatefulSetUpdateStrategy v1beta2 apps
+
+
-
pretty
-
If 'true', then the output is pretty printed.
+
Group
+
Version
+
Kind
+
+
-
resourceVersion
-
When 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.
+
apps
+
v1beta2
+
StatefulSetUpdateStrategy
+
+
+
+
+
+
+
StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy.
curl Command (requires kubectl proxy to be running)
-
-
-Coming Soon
-
-
-
Output
-
-
-Coming Soon
-
-
-
Response Body
-
-
-Coming Soon
-
-
watch changes to an object of kind StatefulSet
-
HTTP Request
-
GET /apis/apps/v1beta1/watch/namespaces/{namespace}/statefulsets/{name}
-
Path Parameters
+
+
+
+
StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy.
RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType.
-
namespace
-
object name and auth scope, such as for teams and projects
+
type string
+
Type indicates the type of the StatefulSetUpdateStrategy.
-
Query Parameters
+
+
StorageClass v1beta1 storage
-
Parameter
+
Group
+
Version
+
Kind
+
+
+
+
+
storage
+
v1beta1
+
StorageClass
+
+
+
+
+
+
+
StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned.
+
StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name.
+
+
+
+
+
+
Field
Description
-
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.
+
allowVolumeExpansion boolean
+
AllowVolumeExpansion shows whether the storage class allow volume expand
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
mountOptions string array
+
Dynamically provisioned PersistentVolumes of this storage class are created with these mountOptions, e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid.
-
pretty
-
If 'true', then the output is pretty printed.
+
parameters object
+
Parameters holds the parameters for the provisioner that should create volumes of this storage class.
-
resourceVersion
-
When 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.
+
provisioner string
+
Provisioner indicates the type of the provisioner.
-
timeoutSeconds
-
Timeout for the list/watch call.
+
reclaimPolicy string
+
Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. Defaults to Delete.
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
volumeBindingMode string
+
VolumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is alpha-level and is only honored by servers that enable the VolumeScheduling feature.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch individual changes to a list of StatefulSet
+
create a StorageClass
HTTP Request
-
GET /apis/apps/v1beta1/watch/namespaces/{namespace}/statefulsets
-
Path Parameters
+
POST /apis/storage.k8s.io/v1beta1/storageclasses
+
Query Parameters
@@ -106363,12 +112408,12 @@
Path Parameters
-
namespace
-
object name and auth scope, such as for teams and projects
+
pretty
+
If 'true', then the output is pretty printed.
-
Query Parameters
+
Body Parameters
@@ -106378,40 +112423,8 @@
Query Parameters
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
-
-
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
name
+
name of the StorageClass
+
+
+
Query Parameters
+
+
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
Parameter
+
Description
+
+
pretty
If 'true', then the output is pretty printed.
+
+
+
Body Parameters
+
+
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
+
Parameter
+
Description
+
+
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
object name and auth scope, such as for teams and projects
+
name of the StorageClass
@@ -106674,6 +112699,33 @@
Query Parameters
pretty
If 'true', then the output is pretty printed.
+
+
gracePeriodSeconds
+
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
+
+
+
orphanDependents
+
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
+
+
+
propagationPolicy
+
Whether and how garbage collection will be performed. 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.
object name and auth scope, such as for teams and projects
+
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.
-
-
-
Query Parameters
-
-
-
Parameter
-
Description
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
pretty
-
If 'true', then the output is pretty printed.
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
-
-
-
Body Parameters
-
-
-
Parameter
-
Description
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
replace scale of the specified StatefulSet
+
list or watch objects of kind StorageClass
HTTP Request
-
PUT /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/scale
-
Path Parameters
+
GET /apis/storage.k8s.io/v1beta1/storageclasses
+
Query Parameters
@@ -106904,42 +112966,40 @@
Path Parameters
-
name
-
name of the Scale
+
pretty
+
If 'true', then the output is pretty printed.
-
namespace
-
object name and auth scope, such as for teams and projects
+
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.
-
-
-
Query Parameters
-
-
-
Parameter
-
Description
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
pretty
-
If 'true', then the output is pretty printed.
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
-
-
-
Body Parameters
-
-
-
Parameter
-
Description
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
GET /apis/storage.k8s.io/v1beta1/watch/storageclasses/{name}
Path Parameters
@@ -107001,11 +113061,7 @@
Path Parameters
name
-
name of the Scale
-
-
-
namespace
-
object name and auth scope, such as for teams and projects
+
name of the StorageClass
@@ -107019,23 +113075,40 @@
Query Parameters
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
pretty
If 'true', then the output is pretty printed.
-
-
-
Body Parameters
-
-
-
Parameter
-
Description
+
resourceVersion
+
When 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.
Last time the condition transitioned from one status to another.
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
pretty
+
If 'true', then the output is pretty printed.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
message string
-
A human readable message indicating details about the transition.
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
-
reason string
-
The reason for the condition's last transition.
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
+
+
Response
+
+
-
status string
-
Status of the condition, one of True, False, Unknown.
StatefulSetCondition describes the state of a statefulset at a certain point.
+
Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names.
Last time the condition transitioned from one status to another.
-
-
-
message string
-
A human readable message indicating details about the transition.
+
apiGroup string
+
APIGroup holds the API group of the referenced subject. Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects.
-
reason string
-
The reason for the condition's last transition.
+
kind string
+
Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error.
-
status string
-
Status of the condition, one of True, False, Unknown.
+
name string
+
Name of the object being referenced.
-
type string
-
Type of statefulset condition.
+
namespace string
+
Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error.
-
StatefulSetUpdateStrategy v1beta2 apps
+
Subject v1alpha1 rbac
@@ -107184,21 +113289,22 @@
StatefulSetUpdateStrategy v1beta
-
apps
-
v1beta2
-
StatefulSetUpdateStrategy
+
rbac
+
v1alpha1
+
Subject
-
+
-
StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy.
+
Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names.
RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType.
+
apiVersion string
+
APIVersion holds the API group and version of the referenced subject. Defaults to "v1" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io/v1alpha1" for User and Group subjects.
-
type string
-
Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate.
+
kind string
+
Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error.
+
+
+
name string
+
Name of the object being referenced.
+
+
+
namespace string
+
Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error.
-
StatefulSetUpdateStrategy v1beta1 apps
+
SubjectAccessReview v1beta1 authorization
@@ -107231,23 +113345,16 @@
StatefulSetUpdateStrategy v1beta
-
apps
+
authorization
v1beta1
-
StatefulSetUpdateStrategy
+
SubjectAccessReview
-
-
-
-
StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy.
-
+
SubjectAccessReview checks whether or not a user or group can perform an action.
Extra corresponds to the user.Info.GetExtra() method from the authenticator. Since that is input to the authorizer it needs a reflection here.
-
mountOptions string array
-
Dynamically provisioned PersistentVolumes of this storage class are created with these mountOptions, e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid.
+
group string array
+
Groups is the groups you're testing for.
-
parameters object
-
Parameters holds the parameters for the provisioner that should create volumes of this storage class.
ResourceAuthorizationAttributes describes information for a resource access request
-
reclaimPolicy string
-
Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. Defaults to Delete.
+
uid string
+
UID information about the requesting user.
-
volumeBindingMode string
-
VolumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is alpha-level and is only honored by servers that enable the VolumeScheduling feature.
+
user string
+
User is the user you're testing for. If you specify "User" but not "Group", then is it interpreted as "What if User were not a member of any groups
Denied is optional. True if the action would be denied, otherwise false. If both allowed is false and denied is false, then the authorizer has no opinion on whether to authorize the action. Denied may not be true if Allowed is true.
EvaluationError is an indication that some error occurred during the authorization check. It is entirely possible to get an error and be able to continue determine authorization status in spite of it. For instance, RBAC can be missing a role, but enough roles are still present and bound to reason about the request.
SubjectRulesReviewStatus contains the result of a rules check. This check can be incomplete depending on the set of authorizers the server is configured with and any errors experienced during evaluation. Because authorization rules are additive, if a rule appears in a list it's safe to assume the subject has that permission, even if that list is incomplete.
+
+
-
Parameter
+
Field
Description
-
name
-
name of the StorageClass
+
evaluationError string
+
EvaluationError can appear in combination with Rules. It indicates an error occurred during rule evaluation, such as an authorizer that doesn't support rule evaluation, and that ResourceRules and/or NonResourceRules may be incomplete.
+
+
+
incomplete boolean
+
Incomplete is true when the rules returned by this call are incomplete. This is most commonly encountered when an authorizer, such as an external authorizer, doesn't support rules evaluation.
NonResourceRules is the list of actions the subject is allowed to perform on non-resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.
ResourceRules is the list of actions the subject is allowed to perform on resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.
-
Query Parameters
+
+
SupplementalGroupsStrategyOptions v1beta1 policy
-
Parameter
+
Group
+
Version
+
Kind
+
+
+
+
+
policy
+
v1beta1
+
SupplementalGroupsStrategyOptions
+
+
+
+
SupplementalGroupsStrategyOptions defines the strategy type and options used to create the strategy.
Ranges are the allowed ranges of supplemental groups. If you would like to force a single supplemental group then supply a single range with the same start and end.
+
+
+
rule string
+
Rule is the strategy that will dictate what supplemental groups is used in the SecurityContext.
-
Body Parameters
+
+
TokenReview v1beta1 authentication
-
Parameter
+
Group
+
Version
+
Kind
+
+
+
+
+
authentication
+
v1beta1
+
TokenReview
+
+
+
+
+
+
+
TokenReview attempts to authenticate a token to a known user. Note: TokenReview requests may be cached by the webhook token authenticator plugin in the kube-apiserver.
UserInfo holds the information about the user needed to implement the user.Info interface.
+
+
-
Parameter
+
Field
Description
-
pretty
-
If 'true', then the output is pretty printed.
+
extra object
+
Any additional information provided by the authenticator.
-
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.
+
groups string array
+
The names of groups this user is a part of.
-
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.
+
uid string
+
A unique value that identifies this user across time. If this user is deleted and another user by the same name is added, they will have different UIDs.
-
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.
+
username string
+
The name that uniquely identifies this user among all active users.
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.
+
attacher string
+
Attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName().
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
nodeName string
+
The node that the volume should be attached to.
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
Source represents the volume that should be attached.
+
+
+
VolumeAttachmentStatus v1alpha1 storage
+
+
+
+
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
Field
+
Description
+
+
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
The last error encountered during attach operation, if any. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
-
resourceVersion
-
When 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.
+
attached boolean
+
Indicates the volume is successfully attached. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
-
timeoutSeconds
-
Timeout for the list/watch call.
+
attachmentMetadata object
+
Upon successful attach, this field is populated with any information returned by the attach operation that must be passed into subsequent WaitForAttach or Mount calls. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
The last error encountered during detach operation, if any. This field must only be set by the entity completing the detach operation, i.e. the external-attacher.
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
name
+
name of the VolumeAttachment
+
+
+
Query Parameters
+
+
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
Parameter
+
Description
+
+
-
resourceVersion
-
When 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.
+
pretty
+
If 'true', then the output is pretty printed.
+
+
+
Body Parameters
+
+
-
timeoutSeconds
-
Timeout for the list/watch call.
+
Parameter
+
Description
+
+
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
watch changes to an object of kind StorageClass
+
replace the specified VolumeAttachment
HTTP Request
-
GET /apis/storage.k8s.io/v1beta1/watch/storageclasses/{name}
+
PUT /apis/storage.k8s.io/v1alpha1/volumeattachments/{name}
Path Parameters
@@ -108034,7 +114269,7 @@
Path Parameters
name
-
name of the StorageClass
+
name of the VolumeAttachment
@@ -108048,40 +114283,23 @@
Query Parameters
-
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
pretty
If 'true', then the output is pretty printed.
+
+
+
Body Parameters
+
+
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
+
Parameter
+
Description
+
+
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
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.
-
-
-
fieldSelector
-
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
-
-
includeUninitialized
-
If true, partially initialized resources are included in the response.
-
-
-
labelSelector
-
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
limit
-
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
-
pretty
-
If 'true', then the output is pretty printed.
-
-
-
resourceVersion
-
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
-
-
-
timeoutSeconds
-
Timeout for the list/watch call.
-
-
-
watch
-
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names.
-
-
-
-
-
-
Field
-
Description
-
-
-
-
-
apiGroup string
-
APIGroup holds the API group of the referenced subject. Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects.
-
-
-
kind string
-
Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error.
-
-
-
name string
-
Name of the object being referenced.
-
-
-
namespace string
-
Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error.
-
-
-
-
-
Subject v1alpha1 rbac
-
-
-
-
Group
-
Version
-
Kind
-
-
-
-
-
rbac
-
v1alpha1
-
Subject
+
name
+
name of the VolumeAttachment
-
-
-
-
Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names.
-
-
+
Query Parameters
-
Field
+
Parameter
Description
-
apiVersion string
-
APIVersion holds the API group and version of the referenced subject. Defaults to "v1" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io/v1alpha1" for User and Group subjects.
-
-
-
kind string
-
Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error.
-
-
-
name string
-
Name of the object being referenced.
+
pretty
+
If 'true', then the output is pretty printed.
-
namespace string
-
Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error.
+
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.
-
-
-
-
SubjectAccessReview v1beta1 authorization
-
-
-
Group
-
Version
-
Kind
+
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.
-
-
-
-
authorization
-
v1beta1
-
SubjectAccessReview
+
+
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.
-
-
-
-
SubjectAccessReview checks whether or not a user or group can perform an action.
Extra corresponds to the user.Info.GetExtra() method from the authenticator. Since that is input to the authorizer it needs a reflection here.
+
pretty
+
If 'true', then the output is pretty printed.
-
group string array
-
Groups is the groups you're testing for.
+
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.
ResourceAuthorizationAttributes describes information for a resource access request
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
-
uid string
-
UID information about the requesting user.
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
user string
-
User is the user you're testing for. If you specify "User" but not "Group", then is it interpreted as "What if User were not a member of any groups
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
-
SubjectAccessReviewStatus v1beta1 authorization
-
-
+
Response
-
Field
+
Code
Description
-
allowed boolean
-
Allowed is required. True if the action would be allowed, false otherwise.
-
-
-
denied boolean
-
Denied is optional. True if the action would be denied, otherwise false. If both allowed is false and denied is false, then the authorizer has no opinion on whether to authorize the action. Denied may not be true if Allowed is true.
-
-
-
evaluationError string
-
EvaluationError is an indication that some error occurred during the authorization check. It is entirely possible to get an error and be able to continue determine authorization status in spite of it. For instance, RBAC can be missing a role, but enough roles are still present and bound to reason about the request.
-
-
-
reason string
-
Reason is optional. It indicates why a request was allowed or denied.
curl Command (requires kubectl proxy to be running)
+
+
+Coming Soon
-
SubjectRulesReviewStatus contains the result of a rules check. This check can be incomplete depending on the set of authorizers the server is configured with and any errors experienced during evaluation. Because authorization rules are additive, if a rule appears in a list it's safe to assume the subject has that permission, even if that list is incomplete.
GET /apis/storage.k8s.io/v1alpha1/volumeattachments
+
Query Parameters
-
Field
+
Parameter
Description
-
evaluationError string
-
EvaluationError can appear in combination with Rules. It indicates an error occurred during rule evaluation, such as an authorizer that doesn't support rule evaluation, and that ResourceRules and/or NonResourceRules may be incomplete.
+
pretty
+
If 'true', then the output is pretty printed.
-
incomplete boolean
-
Incomplete is true when the rules returned by this call are incomplete. This is most commonly encountered when an authorizer, such as an external authorizer, doesn't support rules evaluation.
+
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.
NonResourceRules is the list of actions the subject is allowed to perform on non-resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
ResourceRules is the list of actions the subject is allowed to perform on resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
curl Command (requires kubectl proxy to be running)
+
+
+Coming Soon
+
+
+
Output
+
+
+Coming Soon
-
TokenReview attempts to authenticate a token to a known user. Note: TokenReview requests may be cached by the webhook token authenticator plugin in the kube-apiserver.
+
+
+
Response Body
+
+
+Coming Soon
+
+
+
watch changes to an object of kind VolumeAttachment
+
HTTP Request
+
GET /apis/storage.k8s.io/v1alpha1/watch/volumeattachments/{name}
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.
Status is filled in by the server and indicates whether the request can be authenticated.
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
-
-
TokenReviewSpec v1beta1 authentication
-
-
-
-
-
Field
-
Description
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
-
-
-
token string
-
Token is the opaque bearer token.
+
pretty
+
If 'true', then the output is pretty printed.
+
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
-
TokenReviewStatus v1beta1 authentication
-
-
+
Response
-
Field
+
Code
Description
-
authenticated boolean
-
Authenticated indicates that the token was associated with a known user.
-
-
-
error string
-
Error indicates that the token couldn't be checked
curl Command (requires kubectl proxy to be running)
Coming Soon
+
Output
Coming Soon
+
Response Body
Coming Soon
+
-
create a TokenReview
+
watch individual changes to a list of VolumeAttachment
HTTP Request
-
POST /apis/authentication.k8s.io/v1beta1/tokenreviews
+
GET /apis/storage.k8s.io/v1alpha1/watch/volumeattachments
Query Parameters
@@ -108715,51 +114852,103 @@
Query Parameters
+
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.
+
+
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
includeUninitialized
+
If true, partially initialized resources are included in the response.
+
+
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
limit
+
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
+
+
pretty
If 'true', then the output is pretty printed.
+
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
+
+
+
timeoutSeconds
+
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
VolumeAttachmentSource represents a volume that should be attached. Right now only PersistenVolumes can be attached via external attacher, in future we may allow also inline volumes in pods. Exactly one member can be set.
UserInfo holds the information about the user needed to implement the user.Info interface.
+
VolumeError captures an error encountered during a volume operation.
@@ -108796,20 +114985,12 @@
UserInfo v1beta1 authentication
-
extra object
-
Any additional information provided by the authenticator.
-
-
-
groups string array
-
The names of groups this user is a part of.
-
-
-
uid string
-
A unique value that identifies this user across time. If this user is deleted and another user by the same name is added, they will have different UIDs.
+
message string
+
String detailing the error encountered during Attach or Detach operation. This string maybe logged, so it should not contain sensitive information.
-
username string
-
The name that uniquely identifies this user among all active users.