Welcome to the Kubernetes API. You can use the Kubernetes API to read +and write Kubernetes resource objects via a Kubernetes API endpoint.
+ +This is a high-level overview of the basic types of resources provide by the Kubernetes API and their primary functions.
+Workloads are objects you use to manage and run your containers on the cluster.
+Discovery & LB resources are objects you use to "stitch" your workloads together into an externally accessible, load-balanced Service.
+Config & Storage resources are objects you use to inject initialization data into your applications, and to persist data that is external to your container.
+Cluster resources objects define how the cluster itself is configured; these are typically used only by cluster operators.
+Metadata resources are objects you use to configure the behavior of other resources within the cluster, such as HorizontalPodAutoscaler for scaling workloads.
Resource objects typically have 3 components:
+Most resources provide the following Operations:
+ +Create operations will create the resource in the storage backend. After a resource is create the system will apply +the desired state.
+ +Updates come in 2 forms: Replace and Patch: + +
ConfigMap or Secret resource will not result in all Pods seeing the changes unless the Pods are
+restarted out of band.Reads come in 3 forms: Get, List and Watch:
+ +
Delete will delete a resource. Depending on the specific resource, child objects may or may not be garbage collected by the server. See +notes on specific resource objects for details.
+ +Resources may define additional operations specific to that resource type.
+ +
+name: nginx
+# Run the nginx:1.10 image
+image: nginx:1.10
+
+
+name: nginx
+# Run the nginx:1.10 image
+image: nginx:1.10
+
+| Group | Version | Kind |
|---|---|---|
core | v1 | Container |
Warning:
Containers are only ever created within the context of a Pod. This is usually done using a Controller. See Controllers: Deployment, Job, or StatefulSet
| Field | Description |
|---|---|
argsstring array | Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell |
commandstring array | Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell |
envEnvVar array patch strategy: merge patch merge key: name | List of environment variables to set in the container. Cannot be updated. |
envFromEnvFromSource array | List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. |
imagestring | Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. |
imagePullPolicystring | Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images |
lifecycleLifecycle | Actions that the management system should take in response to container lifecycle events. Cannot be updated. |
livenessProbeProbe | Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
namestring | Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. |
portsContainerPort array patch strategy: merge patch merge key: containerPort | List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. |
readinessProbeProbe | Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
resourcesResourceRequirements | Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |
securityContextSecurityContext | Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ |
stdinboolean | Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. |
stdinOnceboolean | Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false |
terminationMessagePathstring | Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. |
terminationMessagePolicystring | Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. |
ttyboolean | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. |
volumeDevicesVolumeDevice array patch strategy: merge patch merge key: devicePath | volumeDevices is the list of block devices to be used by the container. This is a beta feature. |
volumeMountsVolumeMount array patch strategy: merge patch merge key: mountPath | Pod volumes to mount into the container's filesystem. Cannot be updated. |
workingDirstring | Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. |
| Field | Description |
|---|---|
containerIDstring | Container's ID in the format 'docker://<container_id>'. |
imagestring | The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images |
imageIDstring | ImageID of the container's image. |
lastStateContainerState | Details about the container's last termination condition. |
namestring | This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated. |
readyboolean | Specifies whether the container has passed its readiness probe. |
restartCountinteger | The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. But those containers are subject to garbage collection. This value will get capped at 5 by GC. |
stateContainerState | Details about the container's current condition. |
| Group | Version | Kind |
|---|---|---|
batch | v1beta1 | CronJob |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
specCronJobSpec | Specification of the desired behavior of a cron job, including the schedule. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
statusCronJobStatus | Current status of a cron job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
concurrencyPolicystring | Specifies how to treat concurrent executions of a Job. Valid values are: - "Allow" (default): allows CronJobs to run concurrently; - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - "Replace": cancels currently running job and replaces it with a new one |
failedJobsHistoryLimitinteger | The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1. |
jobTemplateJobTemplateSpec | Specifies the job that will be created when executing a CronJob. |
schedulestring | The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. |
startingDeadlineSecondsinteger | Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones. |
successfulJobsHistoryLimitinteger | The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 3. |
suspendboolean | This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false. |
| Field | Description |
|---|---|
activeObjectReference array | A list of pointers to currently running jobs. |
lastScheduleTimeTime | Information when was the last time the job was successfully scheduled. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsCronJob array | items is the list of CronJobs. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
create a CronJob
+POST /apis/batch/v1beta1/namespaces/{namespace}/cronjobs
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyCronJob |
| Code | Description |
|---|---|
| 200 CronJob | OK |
| 201 CronJob | Created |
| 202 CronJob | Accepted |
partially update the specified CronJob
+PATCH /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}
+| Parameter | Description |
|---|---|
name | name of the CronJob |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 CronJob | OK |
replace the specified CronJob
+PUT /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}
+| Parameter | Description |
|---|---|
name | name of the CronJob |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyCronJob |
| Code | Description |
|---|---|
| 200 CronJob | OK |
| 201 CronJob | Created |
delete a CronJob
+DELETE /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}
+| Parameter | Description |
|---|---|
name | name of the CronJob |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of CronJob
+DELETE /apis/batch/v1beta1/namespaces/{namespace}/cronjobs
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified CronJob
+GET /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}
+| Parameter | Description |
|---|---|
name | name of the CronJob |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 CronJob | OK |
list or watch objects of kind CronJob
+GET /apis/batch/v1beta1/namespaces/{namespace}/cronjobs
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 CronJobList | OK |
list or watch objects of kind CronJob
+GET /apis/batch/v1beta1/cronjobs
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 CronJobList | OK |
watch changes to an object of kind CronJob. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/batch/v1beta1/watch/namespaces/{namespace}/cronjobs/{name}
+| Parameter | Description |
|---|---|
name | name of the CronJob |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of CronJob. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/batch/v1beta1/watch/namespaces/{namespace}/cronjobs
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of CronJob. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/batch/v1beta1/watch/cronjobs
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified CronJob
+PATCH /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}/status
+| Parameter | Description |
|---|---|
name | name of the CronJob |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 CronJob | OK |
read status of the specified CronJob
+GET /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}/status
+| Parameter | Description |
|---|---|
name | name of the CronJob |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 CronJob | OK |
replace status of the specified CronJob
+PUT /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}/status
+| Parameter | Description |
|---|---|
name | name of the CronJob |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyCronJob |
| Code | Description |
|---|---|
| 200 CronJob | OK |
| 201 CronJob | Created |
+apiVersion: extensions/v1beta1
+kind: DaemonSet
+metadata:
+ # Unique key of the DaemonSet instance
+ name: daemonset-example
+spec:
+ template:
+ metadata:
+ labels:
+ app: daemonset-example
+ spec:
+ containers:
+ # This container is run once on each Node in the cluster
+ - name: daemonset-example
+ image: ubuntu:trusty
+ command:
+ - /bin/sh
+ args:
+ - -c
+ # This script is run through `sh -c <script>`
+ - >-
+ while [ true ]; do
+ echo "DaemonSet running on $(hostname)" ;
+ sleep 10 ;
+ done
+
+apiVersion: extensions/v1beta1
+kind: DaemonSet
+metadata:
+ # Unique key of the DaemonSet instance
+ name: daemonset-example
+spec:
+ template:
+ metadata:
+ labels:
+ app: daemonset-example
+ spec:
+ containers:
+ # This container is run once on each Node in the cluster
+ - name: daemonset-example
+ image: ubuntu:trusty
+ command:
+ - /bin/sh
+ args:
+ - -c
+ # This script is run through `sh -c <script>`
+ - >-
+ while [ true ]; do
+ echo "DaemonSet running on $(hostname)" ;
+ sleep 10 ;
+ done
+| Group | Version | Kind |
|---|---|---|
apps | v1 | DaemonSet |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
specDaemonSetSpec | The desired behavior of this daemon set. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
statusDaemonSetStatus | The current status of this daemon set. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
minReadySecondsinteger | The minimum number of seconds for which a newly created DaemonSet 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). |
revisionHistoryLimitinteger | The number of old history to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10. |
selectorLabelSelector | A label query over pods that are managed by the daemon set. Must match in order to be controlled. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors |
templatePodTemplateSpec | An object that describes the pod that will be created. The DaemonSet will create exactly one copy of this pod on every node that matches the template's node selector (or on every node if no node selector is specified). More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template |
updateStrategyDaemonSetUpdateStrategy | An update strategy to replace existing DaemonSet pods with new pods. |
| Field | Description |
|---|---|
collisionCountinteger | Count of hash collisions for the DaemonSet. The DaemonSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision. |
conditionsDaemonSetCondition array patch strategy: merge patch merge key: type | Represents the latest available observations of a DaemonSet's current state. |
currentNumberScheduledinteger | The number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/ |
desiredNumberScheduledinteger | The total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/ |
numberAvailableinteger | The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and available (ready for at least spec.minReadySeconds) |
numberMisscheduledinteger | The number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/ |
numberReadyinteger | The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready. |
numberUnavailableinteger | The number of nodes that should be running the daemon pod and have none of the daemon pod running and available (ready for at least spec.minReadySeconds) |
observedGenerationinteger | The most recent generation observed by the daemon set controller. |
updatedNumberScheduledinteger | The total number of nodes that are running updated daemon pod |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsDaemonSet array | A list of daemon sets. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| Field | Description |
|---|---|
maxUnavailable | The maximum number of DaemonSet pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of total number of DaemonSet pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding up. This cannot be 0. Default value is 1. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their pods stopped for an update at any given time. The update starts by stopping at most 30% of those DaemonSet pods and then brings up new DaemonSet pods in their place. Once the new pods are available, it then proceeds onto other DaemonSet pods, thus ensuring that at least 70% of original number of DaemonSet pods are available at all times during the update. |
kubectl command
+$ echo 'apiVersion: extensions/v1beta1
+kind: DaemonSet
+metadata:
+ name: daemonset-example
+spec:
+ template:
+ metadata:
+ labels:
+ app: daemonset-example
+ spec:
+ containers:
+ - name: daemonset-example
+ image: ubuntu:trusty
+ command:
+ - /bin/sh
+ args:
+ - -c
+ - >-
+ while [ true ]; do
+ echo "DaemonSet running on $(hostname)" ;
+ sleep 10 ;
+ done
+' | kubectl create -f -
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X POST -H 'Content-Type: application/yaml' --data '
+apiVersion: extensions/v1beta1
+kind: DaemonSet
+metadata:
+ name: daemonset-example
+spec:
+ template:
+ metadata:
+ labels:
+ app: daemonset-example
+ spec:
+ containers:
+ - name: daemonset-example
+ image: ubuntu:trusty
+ command:
+ - /bin/sh
+ args:
+ - -c
+ - >-
+ while [ true ]; do
+ echo "DaemonSet running on $(hostname)" ;
+ sleep 10 ;
+ done
+' http://127.0.0.1:8001/apis/apps/v1/namespaces/default/daemonsets
+
+daemonset "daemonset-example" created
+
+{
+ "kind": "DaemonSet",
+ "apiVersion": "extensions/v1beta1",
+ "metadata": {
+ "name": "daemonset-example",
+ "namespace": "default",
+ "selfLink": "/apis/extensions/v1beta1/namespaces/default/daemonsets/daemonset-example",
+ "uid": "65552ced-b0e2-11e6-aef0-42010af00229",
+ "resourceVersion": "3558",
+ "generation": 1,
+ "creationTimestamp": "2016-11-22T18:35:09Z",
+ "labels": {
+ "app": "daemonset-example"
+ }
+ },
+ "spec": {
+ "selector": {
+ "matchLabels": {
+ "app": "daemonset-example"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "daemonset-example"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "daemonset-example",
+ "image": "ubuntu:trusty",
+ "command": [
+ "/bin/sh"
+ ],
+ "args": [
+ "-c",
+ "while [ true ]; do echo \"DaemonSet running on $(hostname)\" ; sleep 10 ; done"
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ }
+ },
+ "status": {
+ "currentNumberScheduled": 0,
+ "numberMisscheduled": 0,
+ "desiredNumberScheduled": 0
+ }
+}
+create a DaemonSet
+POST /apis/apps/v1/namespaces/{namespace}/daemonsets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyDaemonSet |
| Code | Description |
|---|---|
| 200 DaemonSet | OK |
| 201 DaemonSet | Created |
| 202 DaemonSet | Accepted |
partially update the specified DaemonSet
+PATCH /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}
+| Parameter | Description |
|---|---|
name | name of the DaemonSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 DaemonSet | OK |
replace the specified DaemonSet
+PUT /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}
+| Parameter | Description |
|---|---|
name | name of the DaemonSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyDaemonSet |
| Code | Description |
|---|---|
| 200 DaemonSet | OK |
| 201 DaemonSet | Created |
kubectl command
+$ kubectl delete daemonset daemonset-example
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
+gracePeriodSeconds: 0
+orphanDependents: false
+' 'http://127.0.0.1:8001/apis/apps/v1/namespaces/default/daemonsets/daemonset-example'
+
+daemonset "daemonset-example" deleted
+
+{
+ "kind": "Status",
+ "apiVersion": "v1",
+ "metadata": {},
+ "status": "Success",
+ "code": 200
+}
+
+delete a DaemonSet
+DELETE /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}
+| Parameter | Description |
|---|---|
name | name of the DaemonSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of DaemonSet
+DELETE /apis/apps/v1/namespaces/{namespace}/daemonsets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
kubectl command
+$ 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
+read the specified DaemonSet
+GET /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}
+| Parameter | Description |
|---|---|
name | name of the DaemonSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 DaemonSet | OK |
list or watch objects of kind DaemonSet
+GET /apis/apps/v1/namespaces/{namespace}/daemonsets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 DaemonSetList | OK |
list or watch objects of kind DaemonSet
+GET /apis/apps/v1/daemonsets
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 DaemonSetList | OK |
watch changes to an object of kind DaemonSet. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/apps/v1/watch/namespaces/{namespace}/daemonsets/{name}
+| Parameter | Description |
|---|---|
name | name of the DaemonSet |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of DaemonSet. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/apps/v1/watch/namespaces/{namespace}/daemonsets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of DaemonSet. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/apps/v1/watch/daemonsets
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified DaemonSet
+PATCH /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status
+| Parameter | Description |
|---|---|
name | name of the DaemonSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 DaemonSet | OK |
read status of the specified DaemonSet
+GET /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status
+| Parameter | Description |
|---|---|
name | name of the DaemonSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 DaemonSet | OK |
replace status of the specified DaemonSet
+PUT /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status
+| Parameter | Description |
|---|---|
name | name of the DaemonSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyDaemonSet |
| Code | Description |
|---|---|
| 200 DaemonSet | OK |
| 201 DaemonSet | Created |
+apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+ # Unique key of the Deployment instance
+ name: deployment-example
+spec:
+ # 3 Pods should exist at all times.
+ replicas: 3
+ template:
+ metadata:
+ labels:
+ # Apply this label to pods and default
+ # the Deployment label selector to this value
+ app: nginx
+ spec:
+ containers:
+ - name: nginx
+ # Run this image
+ image: nginx:1.10
+
+
+apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+ # Unique key of the Deployment instance
+ name: deployment-example
+spec:
+ # 3 Pods should exist at all times.
+ replicas: 3
+ template:
+ metadata:
+ labels:
+ # Apply this label to pods and default
+ # the Deployment label selector to this value
+ app: nginx
+ spec:
+ containers:
+ - name: nginx
+ # Run this image
+ image: nginx:1.10
+
+| Group | Version | Kind |
|---|---|---|
apps | v1 | Deployment |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object metadata. |
specDeploymentSpec | Specification of the desired behavior of the Deployment. |
statusDeploymentStatus | Most recently observed status of the Deployment. |
| Field | Description |
|---|---|
minReadySecondsinteger | 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) |
pausedboolean | Indicates that the deployment is paused. |
progressDeadlineSecondsinteger | 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. Defaults to 600s. |
replicasinteger | Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1. |
revisionHistoryLimitinteger | The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10. |
selectorLabelSelector | Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template's labels. |
strategyDeploymentStrategy patch strategy: retainKeys | The deployment strategy to use to replace existing pods with new ones. |
templatePodTemplateSpec | Template describes the pods that will be created. |
| Field | Description |
|---|---|
availableReplicasinteger | Total number of available pods (ready for at least minReadySeconds) targeted by this deployment. |
collisionCountinteger | 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. |
conditionsDeploymentCondition array patch strategy: merge patch merge key: type | Represents the latest available observations of a deployment's current state. |
observedGenerationinteger | The generation observed by the deployment controller. |
readyReplicasinteger | Total number of ready pods targeted by this deployment. |
replicasinteger | Total number of non-terminated pods targeted by this deployment (their labels match the selector). |
unavailableReplicasinteger | 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. |
updatedReplicasinteger | Total number of non-terminated pods targeted by this deployment that have the desired template spec. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsDeployment array | Items is the list of Deployments. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. |
| Field | Description |
|---|---|
rollingUpdateRollingUpdateDeployment | Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate. |
typestring | Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate. |
| Field | Description |
|---|---|
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 ReplicaSet 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 ReplicaSet 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 | 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. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods. |
kubectl command
+$ echo 'apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+ name: deployment-example
+spec:
+ replicas: 3
+ revisionHistoryLimit: 10
+ template:
+ metadata:
+ labels:
+ app: nginx
+ spec:
+ containers:
+ - name: nginx
+ image: nginx:1.10
+ ports:
+ - containerPort: 80
+' | kubectl create -f -
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X POST -H 'Content-Type: application/yaml' --data '
+apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+ name: deployment-example
+spec:
+ replicas: 3
+ revisionHistoryLimit: 10
+ template:
+ metadata:
+ labels:
+ app: nginx
+ spec:
+ containers:
+ - name: nginx
+ image: nginx:1.10
+ ports:
+ - containerPort: 80
+' http://127.0.0.1:8001/apis/apps/v1/namespaces/default/deployments
+
+deployment "deployment-example" created
+
+{
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "4ccca349-9cb1-11e6-9c54-42010a800148",
+ "resourceVersion": "2118306",
+ "generation": 1,
+ "creationTimestamp": "2016-10-28T01:53:19Z",
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ },
+ "revisionHistoryLimit": 10
+ },
+ "status": {}
+}
+create a Deployment
+POST /apis/apps/v1/namespaces/{namespace}/deployments
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyDeployment |
| Code | Description |
|---|---|
| 200 Deployment | OK |
| 201 Deployment | Created |
| 202 Deployment | Accepted |
kubectl command
+$ kubectl patch deployment deployment-example -p \
+ '{"spec":{"template":{"spec":{"containers":[{"name":"nginx","image":"nginx:1.11"}]}}}}'
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X PATCH -H 'Content-Type: application/strategic-merge-patch+json' --data '
+{"spec":{"template":{"spec":{"containers":[{"name":"nginx","image":"nginx:1.11"}]}}}}' \
+ 'http://127.0.0.1:8001/apis/apps/v1/namespaces/default/deployments/deployment-example'
+
+"deployment-example" patched
+
+{
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "5dc3a8e6-b0ee-11e6-aef0-42010af00229",
+ "resourceVersion": "164489",
+ "generation": 11,
+ "creationTimestamp": "2016-11-22T20:00:50Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "5"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.11",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ },
+ "revisionHistoryLimit": 10
+ },
+ "status": {
+ "observedGeneration": 10,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+}
+
+partially update the specified Deployment
+PATCH /apis/apps/v1/namespaces/{namespace}/deployments/{name}
+| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Deployment | OK |
kubectl command
+$ echo 'apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+ name: deployment-example
+spec:
+ replicas: 3
+ revisionHistoryLimit: 10
+ template:
+ metadata:
+ labels:
+ app: nginx
+ spec:
+ containers:
+ - name: nginx
+ image: nginx:1.11
+ ports:
+ - containerPort: 80
+' | kubectl replace -f -
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X PUT -H 'Content-Type: application/yaml' --data '
+apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+ name: deployment-example
+spec:
+ replicas: 3
+ revisionHistoryLimit: 10
+ template:
+ metadata:
+ labels:
+ app: nginx
+ spec:
+ containers:
+ - name: nginx
+ image: nginx:1.11
+ ports:
+ - containerPort: 80
+' http://127.0.0.1:8001/apis/apps/v1/namespaces/default/deployments/deployment-example
+
+deployment "deployment-example" replaced
+
+{
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "4ccca349-9cb1-11e6-9c54-42010a800148",
+ "resourceVersion": "2119082",
+ "generation": 5,
+ "creationTimestamp": "2016-10-28T01:53:19Z",
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.11",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ },
+ "revisionHistoryLimit": 10
+ },
+ "status": {
+ "observedGeneration": 4,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+}
+
+replace the specified Deployment
+PUT /apis/apps/v1/namespaces/{namespace}/deployments/{name}
+| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyDeployment |
| Code | Description |
|---|---|
| 201 Deployment | Created |
| 200 Deployment | OK |
kubectl command
+$ kubectl delete deployment deployment-example
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
+gracePeriodSeconds: 0
+orphanDependents: false
+' 'http://127.0.0.1:8001/apis/apps/v1/namespaces/default/deployments/deployment-example'
+
+deployment "deployment-example" deleted
+
+{
+ "kind": "Status",
+ "apiVersion": "v1",
+ "metadata": {},
+ "status": "Success",
+ "code": 200
+}
+
+delete a Deployment
+DELETE /apis/apps/v1/namespaces/{namespace}/deployments/{name}
+| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of Deployment
+DELETE /apis/apps/v1/namespaces/{namespace}/deployments
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
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/v1/namespaces/default/deployments/deployment-example
+
+{
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+ "resourceVersion": "2064726",
+ "generation": 4,
+ "creationTimestamp": "2016-10-27T16:33:35Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "1"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 4,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+}
+
+
+{
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+ "resourceVersion": "2064726",
+ "generation": 4,
+ "creationTimestamp": "2016-10-27T16:33:35Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "1"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 4,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+}
+
+read the specified Deployment
+GET /apis/apps/v1/namespaces/{namespace}/deployments/{name}
+| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 Deployment | OK |
kubectl command
+$ kubectl get deployment -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/deployments'
+
+{
+ "kind": "List",
+ "apiVersion": "v1",
+ "metadata": {},
+ "items": [
+ {
+ "kind": "Deployment",
+ "apiVersion": "app/v1beta1",
+ "metadata": {
+ "name": "docs",
+ "namespace": "default",
+ "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/docs",
+ "uid": "ef49e1d2-915e-11e6-be81-42010a80003f",
+ "resourceVersion": "1924126",
+ "generation": 21,
+ "creationTimestamp": "2016-10-13T16:06:00Z",
+ "labels": {
+ "run": "docs"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "10",
+ "replicatingperfection.net/push-image": "true"
+ }
+ },
+ "spec": {
+ "replicas": 1,
+ "selector": {
+ "matchLabels": {
+ "run": "docs"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "auto-pushed-image-pwittrock/api-docs": "1477496453",
+ "run": "docs"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "docs",
+ "image": "pwittrock/api-docs:v9",
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "Always"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 21,
+ "replicas": 1,
+ "updatedReplicas": 1,
+ "availableReplicas": 1
+ }
+ },
+ {
+ "kind": "Deployment",
+ "apiVersion": "app/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+ "resourceVersion": "2064726",
+ "generation": 4,
+ "creationTimestamp": "2016-10-27T16:33:35Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "1"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 4,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+ }
+ ]
+}
+
+
+{
+ "kind": "List",
+ "apiVersion": "v1",
+ "metadata": {},
+ "items": [
+ {
+ "kind": "Deployment",
+ "apiVersion": "app/v1beta1",
+ "metadata": {
+ "name": "docs",
+ "namespace": "default",
+ "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/docs",
+ "uid": "ef49e1d2-915e-11e6-be81-42010a80003f",
+ "resourceVersion": "1924126",
+ "generation": 21,
+ "creationTimestamp": "2016-10-13T16:06:00Z",
+ "labels": {
+ "run": "docs"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "10",
+ "replicatingperfection.net/push-image": "true"
+ }
+ },
+ "spec": {
+ "replicas": 1,
+ "selector": {
+ "matchLabels": {
+ "run": "docs"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "auto-pushed-image-pwittrock/api-docs": "1477496453",
+ "run": "docs"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "docs",
+ "image": "pwittrock/api-docs:v9",
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "Always"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 21,
+ "replicas": 1,
+ "updatedReplicas": 1,
+ "availableReplicas": 1
+ }
+ },
+ {
+ "kind": "Deployment",
+ "apiVersion": "app/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+ "resourceVersion": "2064726",
+ "generation": 4,
+ "creationTimestamp": "2016-10-27T16:33:35Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "1"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 4,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+ }
+ ]
+}
+
+list or watch objects of kind Deployment
+GET /apis/apps/v1/namespaces/{namespace}/deployments
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 DeploymentList | OK |
list or watch objects of kind Deployment
+GET /apis/apps/v1/deployments
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 DeploymentList | OK |
kubectl command
+$ kubectl get deployment deployment-example --watch -o json
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X GET 'http://127.0.0.1:8001/apis/apps/v1/watch/namespaces/default/deployments/deployment-example'
+
+{
+ "type": "ADDED",
+ "object": {
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "64c12290-9cbf-11e6-9c54-42010a800148",
+ "resourceVersion": "2128095",
+ "generation": 2,
+ "creationTimestamp": "2016-10-28T03:34:12Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "3"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {
+ },
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {
+ }
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 2,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+ }
+}
+
+{
+ "type": "ADDED",
+ "object": {
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "64c12290-9cbf-11e6-9c54-42010a800148",
+ "resourceVersion": "2128095",
+ "generation": 2,
+ "creationTimestamp": "2016-10-28T03:34:12Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "3"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {
+ },
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {
+ }
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 2,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+ }
+}
+watch changes to an object of kind Deployment. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/apps/v1/watch/namespaces/{namespace}/deployments/{name}
+| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Deployment. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/apps/v1/watch/namespaces/{namespace}/deployments
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Deployment. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/apps/v1/watch/deployments
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified Deployment
+PATCH /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status
+| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Deployment | OK |
read status of the specified Deployment
+GET /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status
+| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Deployment | OK |
replace status of the specified Deployment
+PUT /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status
+| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyDeployment |
| Code | Description |
|---|---|
| 200 Deployment | OK |
| 201 Deployment | Created |
read scale of the specified Deployment
+GET /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale
+| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Scale | OK |
replace scale of the specified Deployment
+PUT /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale
+| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyScale |
| Code | Description |
|---|---|
| 200 Scale | OK |
| 201 Scale | Created |
partially update scale of the specified Deployment
+PATCH /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale
+| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Scale | OK |
+apiVersion: batch/v1
+kind: Job
+metadata:
+ # Unique key of the Job instance
+ name: example-job
+spec:
+ template:
+ metadata:
+ name: example-job
+ spec:
+ containers:
+ - name: pi
+ image: perl
+ command: ["perl"]
+ args: ["-Mbignum=bpi", "-wle", "print bpi(2000)"]
+ # Do not restart containers after they exit
+ restartPolicy: Never
+
+
+apiVersion: batch/v1
+kind: Job
+metadata:
+ # Unique key of the Job instance
+ name: example-job
+spec:
+ template:
+ metadata:
+ name: example-job
+ spec:
+ containers:
+ - name: pi
+ image: perl
+ command: ["perl"]
+ args: ["-Mbignum=bpi", "-wle", "print bpi(2000)"]
+ # Do not restart containers after they exit
+ restartPolicy: Never
+
+| Group | Version | Kind |
|---|---|---|
batch | v1 | Job |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
specJobSpec | Specification of the desired behavior of a job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
statusJobStatus | Current status of a job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
activeDeadlineSecondsinteger | Specifies the duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer |
backoffLimitinteger | Specifies the number of retries before marking this job failed. Defaults to 6 |
completionsinteger | Specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ |
manualSelectorboolean | manualSelector controls generation of pod labels and pod selectors. Leave `manualSelector` unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see `manualSelector=true` in jobs that were created with the old `extensions/v1beta1` API. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/#specifying-your-own-pod-selector |
parallelisminteger | Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ |
selectorLabelSelector | A label query over pods that should match the pod count. Normally, the system sets this field for you. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors |
templatePodTemplateSpec | Describes the pod that will be created when executing a job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ |
ttlSecondsAfterFinishedinteger | ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is unset, the Job won't be automatically deleted. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes. This field is alpha-level and is only honored by servers that enable the TTLAfterFinished feature. |
| Field | Description |
|---|---|
activeinteger | The number of actively running pods. |
completionTimeTime | Represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. |
conditionsJobCondition array patch strategy: merge patch merge key: type | The latest available observations of an object's current state. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ |
failedinteger | The number of pods which reached phase Failed. |
startTimeTime | Represents time when the job was acknowledged by the job controller. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. |
succeededinteger | The number of pods which reached phase Succeeded. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsJob array | items is the list of Jobs. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
kubectl command
+$ echo 'apiVersion: batch/v1
+kind: Job
+metadata:
+ name: example-job
+spec:
+ template:
+ metadata:
+ name: example-job
+ spec:
+ containers:
+ - name: pi
+ image: perl
+ command: ["perl", "-Mbignum=bpi", "-wle", "print bpi(2000)"]
+ restartPolicy: Never
+' | kubectl create -f -
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X POST -H 'Content-Type: application/yaml' --data '
+apiVersion: batch/v1
+kind: Job
+metadata:
+ name: example-job
+spec:
+ template:
+ metadata:
+ name: example-job
+ spec:
+ containers:
+ - name: pi
+ image: perl
+ command: ["perl", "-Mbignum=bpi", "-wle", "print bpi(2000)"]
+ restartPolicy: Never
+' http://127.0.0.1:8001/apis/batch/v1/namespaces/default/jobs
+
+job "example-job" created
+
+{
+ "kind": "Job",
+ "apiVersion": "batch/v1",
+ "metadata": {
+ "name": "example-job",
+ "namespace": "default",
+ "selfLink": "/apis/batch/v1/namespaces/default/jobs/example-job",
+ "uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+ "resourceVersion": "7479",
+ "creationTimestamp": "2016-11-04T18:45:25Z"
+ },
+ "spec": {
+ "parallelism": 1,
+ "completions": 1,
+ "selector": {
+ "matchLabels": {
+ "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
+ }
+ },
+ "template": {
+ "metadata": {
+ "name": "example-job",
+ "creationTimestamp": null,
+ "labels": {
+ "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+ "job-name": "example-job"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "pi",
+ "image": "perl",
+ "command": [
+ "perl",
+ "-Mbignum=bpi",
+ "-wle",
+ "print bpi(2000)"
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "Always"
+ }
+ ],
+ "restartPolicy": "Never",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ }
+ },
+ "status": {}
+}
+create a Job
+POST /apis/batch/v1/namespaces/{namespace}/jobs
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyJob |
| Code | Description |
|---|---|
| 200 Job | OK |
| 201 Job | Created |
| 202 Job | Accepted |
partially update the specified Job
+PATCH /apis/batch/v1/namespaces/{namespace}/jobs/{name}
+| Parameter | Description |
|---|---|
name | name of the Job |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Job | OK |
replace the specified Job
+PUT /apis/batch/v1/namespaces/{namespace}/jobs/{name}
+| Parameter | Description |
|---|---|
name | name of the Job |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyJob |
| Code | Description |
|---|---|
| 201 Job | Created |
| 200 Job | OK |
kubectl command
+$ kubectl delete job example-job
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
+gracePeriodSeconds: 0
+orphanDependents: false
+' 'http://127.0.0.1:8001/apis/batch/v1/namespaces/default/jobs/example-job'
+
+job "example-job" deleted
+
+{
+ "kind": "Status",
+ "apiVersion": "v1",
+ "metadata": {},
+ "status": "Success",
+ "code": 200
+}
+
+delete a Job
+DELETE /apis/batch/v1/namespaces/{namespace}/jobs/{name}
+| Parameter | Description |
|---|---|
name | name of the Job |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of Job
+DELETE /apis/batch/v1/namespaces/{namespace}/jobs
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
kubectl command
+$ kubectl get job example-job -o json
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X GET http://127.0.0.1:8001/apis/batch/v1/namespaces/default/jobs/example-job
+
+{
+ "kind": "Job",
+ "apiVersion": "batch/v1",
+ "metadata": {
+ "name": "example-job",
+ "namespace": "default",
+ "selfLink": "/apis/batch/v1/namespaces/default/jobs/example-job",
+ "uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+ "resourceVersion": "7482",
+ "creationTimestamp": "2016-11-04T18:45:25Z"
+ },
+ "spec": {
+ "parallelism": 1,
+ "completions": 1,
+ "selector": {
+ "matchLabels": {
+ "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
+ }
+ },
+ "template": {
+ "metadata": {
+ "name": "example-job",
+ "creationTimestamp": null,
+ "labels": {
+ "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+ "job-name": "example-job"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "pi",
+ "image": "perl",
+ "command": [
+ "perl",
+ "-Mbignum=bpi",
+ "-wle",
+ "print bpi(2000)"
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "Always"
+ }
+ ],
+ "restartPolicy": "Never",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ }
+ },
+ "status": {
+ "startTime": "2016-11-04T18:45:25Z",
+ "active": 1
+ }
+}
+
+{
+ "kind": "Job",
+ "apiVersion": "batch/v1",
+ "metadata": {
+ "name": "example-job",
+ "namespace": "default",
+ "selfLink": "/apis/batch/v1/namespaces/default/jobs/example-job",
+ "uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+ "resourceVersion": "7482",
+ "creationTimestamp": "2016-11-04T18:45:25Z"
+ },
+ "spec": {
+ "parallelism": 1,
+ "completions": 1,
+ "selector": {
+ "matchLabels": {
+ "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
+ }
+ },
+ "template": {
+ "metadata": {
+ "name": "example-job",
+ "creationTimestamp": null,
+ "labels": {
+ "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+ "job-name": "example-job"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "pi",
+ "image": "perl",
+ "command": [
+ "perl",
+ "-Mbignum=bpi",
+ "-wle",
+ "print bpi(2000)"
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "Always"
+ }
+ ],
+ "restartPolicy": "Never",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ }
+ },
+ "status": {
+ "startTime": "2016-11-04T18:45:25Z",
+ "active": 1
+ }
+}
+read the specified Job
+GET /apis/batch/v1/namespaces/{namespace}/jobs/{name}
+| Parameter | Description |
|---|---|
name | name of the Job |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 Job | OK |
kubectl command
+$ kubectl get job -o json
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X GET 'http://127.0.0.1:8001/apis/batch/v1/namespaces/default/jobs'
+
+{
+ "kind": "JobList",
+ "apiVersion": "batch/v1",
+ "metadata": {
+ "selfLink": "/apis/batch/v1/namespaces/default/jobs",
+ "resourceVersion": "7589"
+ },
+ "items": [
+ {
+ "metadata": {
+ "name": "",
+ "namespace": "default",
+ "selfLink": "/apis/batch/v1/namespaces/default/jobs/",
+ "uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+ "resourceVersion": "7482",
+ "creationTimestamp": "2016-11-04T18:45:25Z"
+ },
+ "spec": {
+ "parallelism": 1,
+ "completions": 1,
+ "selector": {
+ "matchLabels": {
+ "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
+ }
+ },
+ "template": {
+ "metadata": {
+ "name": "",
+ "creationTimestamp": null,
+ "labels": {
+ "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+ "job-name": ""
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "pi",
+ "image": "perl",
+ "command": [
+ "perl",
+ "-Mbignum=bpi",
+ "-wle",
+ "print bpi(2000)"
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "Always"
+ }
+ ],
+ "restartPolicy": "Never",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ }
+ },
+ "status": {
+ "startTime": "2016-11-04T18:45:25Z",
+ "active": 1
+ }
+ }
+ ]
+}
+
+{
+ "kind": "JobList",
+ "apiVersion": "batch/v1",
+ "metadata": {
+ "selfLink": "/apis/batch/v1/namespaces/default/jobs",
+ "resourceVersion": "7589"
+ },
+ "items": [
+ {
+ "metadata": {
+ "name": "",
+ "namespace": "default",
+ "selfLink": "/apis/batch/v1/namespaces/default/jobs/",
+ "uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+ "resourceVersion": "7482",
+ "creationTimestamp": "2016-11-04T18:45:25Z"
+ },
+ "spec": {
+ "parallelism": 1,
+ "completions": 1,
+ "selector": {
+ "matchLabels": {
+ "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
+ }
+ },
+ "template": {
+ "metadata": {
+ "name": "",
+ "creationTimestamp": null,
+ "labels": {
+ "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+ "job-name": ""
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "pi",
+ "image": "perl",
+ "command": [
+ "perl",
+ "-Mbignum=bpi",
+ "-wle",
+ "print bpi(2000)"
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "Always"
+ }
+ ],
+ "restartPolicy": "Never",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ }
+ },
+ "status": {
+ "startTime": "2016-11-04T18:45:25Z",
+ "active": 1
+ }
+ }
+ ]
+}
+list or watch objects of kind Job
+GET /apis/batch/v1/namespaces/{namespace}/jobs
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 JobList | OK |
list or watch objects of kind Job
+GET /apis/batch/v1/jobs
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 JobList | OK |
kubectl command
+$ kubectl get job example-job --watch -o json
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X GET 'http://127.0.0.1:8001/apis/batch/v1/watch/namespaces/default/jobs/example-job'
+
+{
+ "type": "ADDED",
+ "object": {
+ "kind": "Job",
+ "apiVersion": "batch/v1",
+ "metadata": {
+ "name": "example-job",
+ "namespace": "default",
+ "selfLink": "/apis/batch/v1/namespaces/default/jobs/example-job",
+ "uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+ "resourceVersion": "7482",
+ "creationTimestamp": "2016-11-04T18:45:25Z"
+ },
+ "spec": {
+ "parallelism": 1,
+ "completions": 1,
+ "selector": {
+ "matchLabels": {
+ "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
+ }
+ },
+ "template": {
+ "metadata": {
+ "name": "example-job",
+ "creationTimestamp": null,
+ "labels": {
+ "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+ "job-name": "example-job"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "pi",
+ "image": "perl",
+ "command": [
+ "perl",
+ "-Mbignum=bpi",
+ "-wle",
+ "print bpi(2000)"
+ ],
+ "resources": {
+ },
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "Always"
+ }
+ ],
+ "restartPolicy": "Never",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {
+ }
+ }
+ }
+ },
+ "status": {
+ "startTime": "2016-11-04T18:45:25Z",
+ "active": 1
+ }
+ }
+}
+
+{
+ "type": "ADDED",
+ "object": {
+ "kind": "Job",
+ "apiVersion": "batch/v1",
+ "metadata": {
+ "name": "example-job",
+ "namespace": "default",
+ "selfLink": "/apis/batch/v1/namespaces/default/jobs/example-job",
+ "uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+ "resourceVersion": "7482",
+ "creationTimestamp": "2016-11-04T18:45:25Z"
+ },
+ "spec": {
+ "parallelism": 1,
+ "completions": 1,
+ "selector": {
+ "matchLabels": {
+ "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
+ }
+ },
+ "template": {
+ "metadata": {
+ "name": "example-job",
+ "creationTimestamp": null,
+ "labels": {
+ "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+ "job-name": "example-job"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "pi",
+ "image": "perl",
+ "command": [
+ "perl",
+ "-Mbignum=bpi",
+ "-wle",
+ "print bpi(2000)"
+ ],
+ "resources": {
+ },
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "Always"
+ }
+ ],
+ "restartPolicy": "Never",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {
+ }
+ }
+ }
+ },
+ "status": {
+ "startTime": "2016-11-04T18:45:25Z",
+ "active": 1
+ }
+ }
+}
+watch changes to an object of kind Job. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/batch/v1/watch/namespaces/{namespace}/jobs/{name}
+| Parameter | Description |
|---|---|
name | name of the Job |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Job. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/batch/v1/watch/namespaces/{namespace}/jobs
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Job. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/batch/v1/watch/jobs
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified Job
+PATCH /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status
+| Parameter | Description |
|---|---|
name | name of the Job |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Job | OK |
read status of the specified Job
+GET /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status
+| Parameter | Description |
|---|---|
name | name of the Job |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Job | OK |
replace status of the specified Job
+PUT /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status
+| Parameter | Description |
|---|---|
name | name of the Job |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyJob |
| Code | Description |
|---|---|
| 200 Job | OK |
| 201 Job | Created |
+apiVersion: v1
+kind: Pod
+metadata:
+ name: pod-example
+spec:
+ containers:
+ - name: ubuntu
+ image: ubuntu:trusty
+ command: ["echo"]
+ args: ["Hello World"]
+
+
+apiVersion: v1
+kind: Pod
+metadata:
+ name: pod-example
+spec:
+ containers:
+ - name: ubuntu
+ image: ubuntu:trusty
+ command: ["echo"]
+ args: ["Hello World"]
+
+| Group | Version | Kind |
|---|---|---|
core | v1 | Pod |
Warning:
It is recommended that users create Pods only through a Controller, and not directly. See Controllers: Deployment, Job, or StatefulSet.
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
specPodSpec | Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
statusPodStatus | Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
activeDeadlineSecondsinteger | Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer. |
affinityAffinity | If specified, the pod's scheduling constraints |
automountServiceAccountTokenboolean | AutomountServiceAccountToken indicates whether a service account token should be automatically mounted. |
containersContainer array patch strategy: merge patch merge key: name | List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. |
dnsConfigPodDNSConfig | Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy. |
dnsPolicystring | 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'. |
enableServiceLinksboolean | EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. |
hostAliasesHostAlias array patch strategy: merge patch merge key: ip | HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods. |
hostIPCboolean | Use the host's ipc namespace. Optional: Default to false. |
hostNetworkboolean | Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false. |
hostPIDboolean | Use the host's pid namespace. Optional: Default to false. |
hostnamestring | Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value. |
imagePullSecretsLocalObjectReference array patch strategy: merge patch merge key: name | ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod |
initContainersContainer array patch strategy: merge patch merge key: name | List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, or Liveness probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
nodeNamestring | NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements. |
nodeSelectorobject | NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ |
priorityinteger | The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority. |
priorityClassNamestring | 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. |
readinessGatesPodReadinessGate array | If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://github.com/kubernetes/community/blob/master/keps/sig-network/0007-pod-ready%2B%2B.md |
restartPolicystring | Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy |
runtimeClassNamestring | RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://github.com/kubernetes/community/blob/master/keps/sig-node/0014-runtime-class.md This is an alpha feature and may change in the future. |
schedulerNamestring | If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler. |
securityContextPodSecurityContext | SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field. |
serviceAccountstring | DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead. |
serviceAccountNamestring | ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ |
shareProcessNamespaceboolean | 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 beta-level and may be disabled with the PodShareProcessNamespace feature. |
subdomainstring | 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. |
terminationGracePeriodSecondsinteger | Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds. |
tolerationsToleration array | If specified, the pod's tolerations. |
volumesVolume array patch strategy: merge,retainKeys patch merge key: name | List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes |
| Field | Description |
|---|---|
conditionsPodCondition array patch strategy: merge patch merge key: type | Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions |
containerStatusesContainerStatus array | The list has one entry per container in the manifest. Each entry is currently the output of `docker inspect`. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status |
hostIPstring | IP address of the host to which the pod is assigned. Empty if not yet scheduled. |
initContainerStatusesContainerStatus array | The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status |
messagestring | A human readable message indicating details about why the pod is in this condition. |
nominatedNodeNamestring | 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. |
phasestring | The phase of a Pod is a simple, high-level summary of where the Pod is in its lifecycle. The conditions array, the reason and message fields, and the individual container status arrays contain more detail about the pod's status. There are five possible phase values: Pending: The pod has been accepted by the Kubernetes system, but one or more of the container images has not been created. This includes time before being scheduled as well as time spent downloading images over the network, which could take a while. Running: The pod has been bound to a node, and all of the containers have been created. At least one container is still running, or is in the process of starting or restarting. Succeeded: All containers in the pod have terminated in success, and will not be restarted. Failed: All containers in the pod have terminated, and at least one container has terminated in failure. The container either exited with non-zero status or was terminated by the system. Unknown: For some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase |
podIPstring | IP address allocated to the pod. Routable at least within the cluster. Empty if not yet allocated. |
qosClassstring | The Quality of Service (QOS) classification assigned to the pod based on resource requirements See PodQOSClass type for available QOS classes More info: https://git.k8s.io/community/contributors/design-proposals/node/resource-qos.md |
reasonstring | A brief CamelCase message indicating details about why the pod is in this state. e.g. 'Evicted' |
startTimeTime | RFC 3339 date and time at which the object was acknowledged by the Kubelet. This is before the Kubelet pulled the container image(s) for the pod. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsPod array | List of pods. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
create a Pod
+POST /api/v1/namespaces/{namespace}/pods
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPod |
| Code | Description |
|---|---|
| 201 Pod | Created |
| 202 Pod | Accepted |
| 200 Pod | OK |
create eviction of a Pod
+POST /api/v1/namespaces/{namespace}/pods/{name}/eviction
+| Parameter | Description |
|---|---|
name | name of the Eviction |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
includeUninitialized | If IncludeUninitialized is specified, the object may be returned without completing initialization. |
pretty | If 'true', then the output is pretty printed. |
| Parameter | Description |
|---|---|
bodyEviction |
| Code | Description |
|---|---|
| 200 Eviction | OK |
| 201 Eviction | Created |
| 202 Eviction | Accepted |
partially update the specified Pod
+PATCH /api/v1/namespaces/{namespace}/pods/{name}
+| Parameter | Description |
|---|---|
name | name of the Pod |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Pod | OK |
replace the specified Pod
+PUT /api/v1/namespaces/{namespace}/pods/{name}
+| Parameter | Description |
|---|---|
name | name of the Pod |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPod |
| Code | Description |
|---|---|
| 200 Pod | OK |
| 201 Pod | Created |
delete a Pod
+DELETE /api/v1/namespaces/{namespace}/pods/{name}
+| Parameter | Description |
|---|---|
name | name of the Pod |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of Pod
+DELETE /api/v1/namespaces/{namespace}/pods
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified Pod
+GET /api/v1/namespaces/{namespace}/pods/{name}
+| Parameter | Description |
|---|---|
name | name of the Pod |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 Pod | OK |
list or watch objects of kind Pod
+GET /api/v1/namespaces/{namespace}/pods
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 PodList | OK |
list or watch objects of kind Pod
+GET /api/v1/pods
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 PodList | OK |
watch changes to an object of kind Pod. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /api/v1/watch/namespaces/{namespace}/pods/{name}
+| Parameter | Description |
|---|---|
name | name of the Pod |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Pod. deprecated: use the 'watch' parameter with a list operation instead.
+GET /api/v1/watch/namespaces/{namespace}/pods
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Pod. deprecated: use the 'watch' parameter with a list operation instead.
+GET /api/v1/watch/pods
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified Pod
+PATCH /api/v1/namespaces/{namespace}/pods/{name}/status
+| Parameter | Description |
|---|---|
name | name of the Pod |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Pod | OK |
read status of the specified Pod
+GET /api/v1/namespaces/{namespace}/pods/{name}/status
+| Parameter | Description |
|---|---|
name | name of the Pod |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Pod | OK |
replace status of the specified Pod
+PUT /api/v1/namespaces/{namespace}/pods/{name}/status
+| Parameter | Description |
|---|---|
name | name of the Pod |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPod |
| Code | Description |
|---|---|
| 200 Pod | OK |
| 201 Pod | Created |
connect POST requests to portforward of Pod
+POST /api/v1/namespaces/{namespace}/pods/{name}/portforward
+| Parameter | Description |
|---|---|
name | name of the PodPortForwardOptions |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
ports | List of ports to forward Required when using WebSockets |
| Code | Description |
|---|---|
| 200 string | OK |
connect POST requests to proxy of Pod
+POST /api/v1/namespaces/{namespace}/pods/{name}/proxy
+| Parameter | Description |
|---|---|
name | name of the PodProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to pod. |
| Code | Description |
|---|---|
| 200 string | OK |
connect POST requests to proxy of Pod
+POST /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
+| Parameter | Description |
|---|---|
name | name of the PodProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
path | path to the resource |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to pod. |
| Code | Description |
|---|---|
| 200 string | OK |
connect DELETE requests to proxy of Pod
+DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy
+| Parameter | Description |
|---|---|
name | name of the PodProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to pod. |
| Code | Description |
|---|---|
| 200 string | OK |
connect DELETE requests to proxy of Pod
+DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
+| Parameter | Description |
|---|---|
name | name of the PodProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
path | path to the resource |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to pod. |
| Code | Description |
|---|---|
| 200 string | OK |
connect GET requests to portforward of Pod
+GET /api/v1/namespaces/{namespace}/pods/{name}/portforward
+| Parameter | Description |
|---|---|
name | name of the PodPortForwardOptions |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
ports | List of ports to forward Required when using WebSockets |
| Code | Description |
|---|---|
| 200 string | OK |
connect GET requests to proxy of Pod
+GET /api/v1/namespaces/{namespace}/pods/{name}/proxy
+| Parameter | Description |
|---|---|
name | name of the PodProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to pod. |
| Code | Description |
|---|---|
| 200 string | OK |
connect GET requests to proxy of Pod
+GET /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
+| Parameter | Description |
|---|---|
name | name of the PodProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
path | path to the resource |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to pod. |
| Code | Description |
|---|---|
| 200 string | OK |
connect HEAD requests to proxy of Pod
+HEAD /api/v1/namespaces/{namespace}/pods/{name}/proxy
+| Parameter | Description |
|---|---|
name | name of the PodProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to pod. |
| Code | Description |
|---|---|
| 200 string | OK |
connect HEAD requests to proxy of Pod
+HEAD /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
+| Parameter | Description |
|---|---|
name | name of the PodProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
path | path to the resource |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to pod. |
| Code | Description |
|---|---|
| 200 string | OK |
connect PUT requests to proxy of Pod
+PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy
+| Parameter | Description |
|---|---|
name | name of the PodProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to pod. |
| Code | Description |
|---|---|
| 200 string | OK |
connect PUT requests to proxy of Pod
+PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
+| Parameter | Description |
|---|---|
name | name of the PodProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
path | path to the resource |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to pod. |
| Code | Description |
|---|---|
| 200 string | OK |
read log of the specified Pod
+GET /api/v1/namespaces/{namespace}/pods/{name}/log
+| Parameter | Description |
|---|---|
name | name of the Pod |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
container | The container for which to stream logs. Defaults to only container if there is one container in the pod. |
follow | Follow the log stream of the pod. Defaults to false. |
limitBytes | If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit. |
pretty | If 'true', then the output is pretty printed. |
previous | Return previous terminated container logs. Defaults to false. |
sinceSeconds | A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified. |
tailLines | If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime |
timestamps | If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false. |
| Code | Description |
|---|---|
| 200 string | OK |
+apiVersion: extensions/v1beta1
+kind: ReplicaSet
+metadata:
+ # Unique key of the ReplicaSet instance
+ name: replicaset-example
+spec:
+ # 3 Pods should exist at all times.
+ replicas: 3
+ template:
+ metadata:
+ labels:
+ app: nginx
+ spec:
+ containers:
+ # Run the nginx image
+ - name: nginx
+ image: nginx:1.10
+
+
+apiVersion: extensions/v1beta1
+kind: ReplicaSet
+metadata:
+ # Unique key of the ReplicaSet instance
+ name: replicaset-example
+spec:
+ # 3 Pods should exist at all times.
+ replicas: 3
+ template:
+ metadata:
+ labels:
+ app: nginx
+ spec:
+ containers:
+ # Run the nginx image
+ - name: nginx
+ image: nginx:1.10
+
+| Group | Version | Kind |
|---|---|---|
apps | v1 | ReplicaSet |
Warning:
In many cases it is recommended to create a Deployment instead of ReplicaSet.
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
specReplicaSetSpec | Spec defines the specification of the desired behavior of the ReplicaSet. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
statusReplicaSetStatus | Status is the most recently observed status of the ReplicaSet. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
minReadySecondsinteger | 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) |
replicasinteger | Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller |
selectorLabelSelector | Selector is a label query over pods that should match the replica count. Label keys and values that must match in order to be controlled by this replica set. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors |
templatePodTemplateSpec | Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template |
| Field | Description |
|---|---|
availableReplicasinteger | The number of available replicas (ready for at least minReadySeconds) for this replica set. |
conditionsReplicaSetCondition array patch strategy: merge patch merge key: type | Represents the latest available observations of a replica set's current state. |
fullyLabeledReplicasinteger | The number of pods that have labels matching the labels of the pod template of the replicaset. |
observedGenerationinteger | ObservedGeneration reflects the generation of the most recently observed ReplicaSet. |
readyReplicasinteger | The number of ready replicas for this replica set. |
replicasinteger | Replicas is the most recently oberved number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsReplicaSet array | List of ReplicaSets. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
create a ReplicaSet
+POST /apis/apps/v1/namespaces/{namespace}/replicasets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyReplicaSet |
| Code | Description |
|---|---|
| 201 ReplicaSet | Created |
| 202 ReplicaSet | Accepted |
| 200 ReplicaSet | OK |
partially update the specified ReplicaSet
+PATCH /apis/apps/v1/namespaces/{namespace}/replicasets/{name}
+| Parameter | Description |
|---|---|
name | name of the ReplicaSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ReplicaSet | OK |
replace the specified ReplicaSet
+PUT /apis/apps/v1/namespaces/{namespace}/replicasets/{name}
+| Parameter | Description |
|---|---|
name | name of the ReplicaSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyReplicaSet |
| Code | Description |
|---|---|
| 201 ReplicaSet | Created |
| 200 ReplicaSet | OK |
delete a ReplicaSet
+DELETE /apis/apps/v1/namespaces/{namespace}/replicasets/{name}
+| Parameter | Description |
|---|---|
name | name of the ReplicaSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of ReplicaSet
+DELETE /apis/apps/v1/namespaces/{namespace}/replicasets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified ReplicaSet
+GET /apis/apps/v1/namespaces/{namespace}/replicasets/{name}
+| Parameter | Description |
|---|---|
name | name of the ReplicaSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 ReplicaSet | OK |
list or watch objects of kind ReplicaSet
+GET /apis/apps/v1/namespaces/{namespace}/replicasets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 ReplicaSetList | OK |
list or watch objects of kind ReplicaSet
+GET /apis/apps/v1/replicasets
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 ReplicaSetList | OK |
watch changes to an object of kind ReplicaSet. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/apps/v1/watch/namespaces/{namespace}/replicasets/{name}
+| Parameter | Description |
|---|---|
name | name of the ReplicaSet |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ReplicaSet. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/apps/v1/watch/namespaces/{namespace}/replicasets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ReplicaSet. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/apps/v1/watch/replicasets
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified ReplicaSet
+PATCH /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status
+| Parameter | Description |
|---|---|
name | name of the ReplicaSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ReplicaSet | OK |
read status of the specified ReplicaSet
+GET /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status
+| Parameter | Description |
|---|---|
name | name of the ReplicaSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 ReplicaSet | OK |
replace status of the specified ReplicaSet
+PUT /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status
+| Parameter | Description |
|---|---|
name | name of the ReplicaSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyReplicaSet |
| Code | Description |
|---|---|
| 200 ReplicaSet | OK |
| 201 ReplicaSet | Created |
read scale of the specified ReplicaSet
+GET /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale
+| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Scale | OK |
replace scale of the specified ReplicaSet
+PUT /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale
+| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyScale |
| Code | Description |
|---|---|
| 200 Scale | OK |
| 201 Scale | Created |
partially update scale of the specified ReplicaSet
+PATCH /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale
+| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Scale | OK |
+apiVersion: v1
+kind: ReplicationController
+metadata:
+ # Unique key of the ReplicationController instance
+ name: replicationcontroller-example
+spec:
+ # 3 Pods should exist at all times.
+ replicas: 3
+ template:
+ metadata:
+ labels:
+ app: nginx
+ spec:
+ containers:
+ # Run the nginx image
+ - name: nginx
+ image: nginx:1.10
+
+
+apiVersion: v1
+kind: ReplicationController
+metadata:
+ # Unique key of the ReplicationController instance
+ name: replicationcontroller-example
+spec:
+ # 3 Pods should exist at all times.
+ replicas: 3
+ template:
+ metadata:
+ labels:
+ app: nginx
+ spec:
+ containers:
+ # Run the nginx image
+ - name: nginx
+ image: nginx:1.10
+
+| Group | Version | Kind |
|---|---|---|
core | v1 | ReplicationController |
Warning:
In many cases it is recommended to create a Deployment instead of a ReplicationController.
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | If the Labels of a ReplicationController are empty, they are defaulted to be the same as the Pod(s) that the replication controller manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
specReplicationControllerSpec | Spec defines the specification of the desired behavior of the replication controller. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
statusReplicationControllerStatus | Status is the most recently observed status of the replication controller. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
minReadySecondsinteger | 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) |
replicasinteger | Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller |
selectorobject | Selector is a label query over pods that should match the Replicas count. If Selector is empty, it is defaulted to the labels present on the Pod template. Label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors |
templatePodTemplateSpec | Template is the object that describes the pod that will be created if insufficient replicas are detected. This takes precedence over a TemplateRef. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template |
| Field | Description |
|---|---|
availableReplicasinteger | The number of available replicas (ready for at least minReadySeconds) for this replication controller. |
conditionsReplicationControllerCondition array patch strategy: merge patch merge key: type | Represents the latest available observations of a replication controller's current state. |
fullyLabeledReplicasinteger | The number of pods that have labels matching the labels of the pod template of the replication controller. |
observedGenerationinteger | ObservedGeneration reflects the generation of the most recently observed replication controller. |
readyReplicasinteger | The number of ready replicas for this replication controller. |
replicasinteger | Replicas is the most recently oberved number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsReplicationController array | List of replication controllers. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
create a ReplicationController
+POST /api/v1/namespaces/{namespace}/replicationcontrollers
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyReplicationController |
| Code | Description |
|---|---|
| 200 ReplicationController | OK |
| 201 ReplicationController | Created |
| 202 ReplicationController | Accepted |
partially update the specified ReplicationController
+PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
+| Parameter | Description |
|---|---|
name | name of the ReplicationController |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ReplicationController | OK |
replace the specified ReplicationController
+PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
+| Parameter | Description |
|---|---|
name | name of the ReplicationController |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyReplicationController |
| Code | Description |
|---|---|
| 200 ReplicationController | OK |
| 201 ReplicationController | Created |
delete a ReplicationController
+DELETE /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
+| Parameter | Description |
|---|---|
name | name of the ReplicationController |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of ReplicationController
+DELETE /api/v1/namespaces/{namespace}/replicationcontrollers
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified ReplicationController
+GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
+| Parameter | Description |
|---|---|
name | name of the ReplicationController |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 ReplicationController | OK |
list or watch objects of kind ReplicationController
+GET /api/v1/namespaces/{namespace}/replicationcontrollers
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 ReplicationControllerList | OK |
list or watch objects of kind ReplicationController
+GET /api/v1/replicationcontrollers
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 ReplicationControllerList | OK |
watch changes to an object of kind ReplicationController. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers/{name}
+| Parameter | Description |
|---|---|
name | name of the ReplicationController |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ReplicationController. deprecated: use the 'watch' parameter with a list operation instead.
+GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ReplicationController. deprecated: use the 'watch' parameter with a list operation instead.
+GET /api/v1/watch/replicationcontrollers
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified ReplicationController
+PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
+| Parameter | Description |
|---|---|
name | name of the ReplicationController |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ReplicationController | OK |
read status of the specified ReplicationController
+GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
+| Parameter | Description |
|---|---|
name | name of the ReplicationController |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 ReplicationController | OK |
replace status of the specified ReplicationController
+PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
+| Parameter | Description |
|---|---|
name | name of the ReplicationController |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyReplicationController |
| Code | Description |
|---|---|
| 200 ReplicationController | OK |
| 201 ReplicationController | Created |
read scale of the specified ReplicationController
+GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
+| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Scale | OK |
replace scale of the specified ReplicationController
+PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
+| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyScale |
| Code | Description |
|---|---|
| 201 Scale | Created |
| 200 Scale | OK |
partially update scale of the specified ReplicationController
+PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
+| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Scale | OK |
| Group | Version | Kind |
|---|---|---|
apps | v1 | StatefulSet |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | |
specStatefulSetSpec | Spec defines the desired identities of pods in this set. |
statusStatefulSetStatus | Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time. |
| Field | Description |
|---|---|
podManagementPolicystring | 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. |
replicasinteger | 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. |
revisionHistoryLimitinteger | 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. |
selectorLabelSelector | selector is a label query over pods that should match the replica count. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors |
serviceNamestring | 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. |
templatePodTemplateSpec | 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. |
updateStrategyStatefulSetUpdateStrategy | updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template. |
volumeClaimTemplatesPersistentVolumeClaim array | 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. |
| Field | Description |
|---|---|
collisionCountinteger | 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. |
conditionsStatefulSetCondition array patch strategy: merge patch merge key: type | Represents the latest available observations of a statefulset's current state. |
currentReplicasinteger | currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision. |
currentRevisionstring | currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas). |
observedGenerationinteger | 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. |
readyReplicasinteger | readyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition. |
replicasinteger | replicas is the number of Pods created by the StatefulSet controller. |
updateRevisionstring | updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [replicas-updatedReplicas,replicas) |
updatedReplicasinteger | updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsStatefulSet array | |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta |
create a StatefulSet
+POST /apis/apps/v1/namespaces/{namespace}/statefulsets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyStatefulSet |
| Code | Description |
|---|---|
| 200 StatefulSet | OK |
| 201 StatefulSet | Created |
| 202 StatefulSet | Accepted |
partially update the specified StatefulSet
+PATCH /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}
+| Parameter | Description |
|---|---|
name | name of the StatefulSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 StatefulSet | OK |
replace the specified StatefulSet
+PUT /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}
+| Parameter | Description |
|---|---|
name | name of the StatefulSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyStatefulSet |
| Code | Description |
|---|---|
| 200 StatefulSet | OK |
| 201 StatefulSet | Created |
delete a StatefulSet
+DELETE /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}
+| Parameter | Description |
|---|---|
name | name of the StatefulSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of StatefulSet
+DELETE /apis/apps/v1/namespaces/{namespace}/statefulsets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified StatefulSet
+GET /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}
+| Parameter | Description |
|---|---|
name | name of the StatefulSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 StatefulSet | OK |
list or watch objects of kind StatefulSet
+GET /apis/apps/v1/namespaces/{namespace}/statefulsets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 StatefulSetList | OK |
list or watch objects of kind StatefulSet
+GET /apis/apps/v1/statefulsets
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 StatefulSetList | OK |
watch changes to an object of kind StatefulSet. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/apps/v1/watch/namespaces/{namespace}/statefulsets/{name}
+| Parameter | Description |
|---|---|
name | name of the StatefulSet |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of StatefulSet. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/apps/v1/watch/namespaces/{namespace}/statefulsets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of StatefulSet. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/apps/v1/watch/statefulsets
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified StatefulSet
+PATCH /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status
+| Parameter | Description |
|---|---|
name | name of the StatefulSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 StatefulSet | OK |
read status of the specified StatefulSet
+GET /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status
+| Parameter | Description |
|---|---|
name | name of the StatefulSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 StatefulSet | OK |
replace status of the specified StatefulSet
+PUT /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status
+| Parameter | Description |
|---|---|
name | name of the StatefulSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyStatefulSet |
| Code | Description |
|---|---|
| 201 StatefulSet | Created |
| 200 StatefulSet | OK |
read scale of the specified StatefulSet
+GET /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale
+| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Scale | OK |
replace scale of the specified StatefulSet
+PUT /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale
+| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyScale |
| Code | Description |
|---|---|
| 200 Scale | OK |
| 201 Scale | Created |
partially update scale of the specified StatefulSet
+PATCH /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale
+| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Scale | OK |
| Group | Version | Kind |
|---|---|---|
core | v1 | Endpoints |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
subsetsEndpointSubset array | The set of all endpoints is the union of all subsets. Addresses are placed into subsets according to the IPs they share. A single address with multiple ports, some of which are ready and some of which are not (because they come from different containers) will result in the address being displayed in different subsets for the different ports. No address will appear in both Addresses and NotReadyAddresses in the same subset. Sets of addresses and ports that comprise a service. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsEndpoints array | List of endpoints. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
create Endpoints
+POST /api/v1/namespaces/{namespace}/endpoints
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyEndpoints |
| Code | Description |
|---|---|
| 201 Endpoints | Created |
| 202 Endpoints | Accepted |
| 200 Endpoints | OK |
partially update the specified Endpoints
+PATCH /api/v1/namespaces/{namespace}/endpoints/{name}
+| Parameter | Description |
|---|---|
name | name of the Endpoints |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Endpoints | OK |
replace the specified Endpoints
+PUT /api/v1/namespaces/{namespace}/endpoints/{name}
+| Parameter | Description |
|---|---|
name | name of the Endpoints |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyEndpoints |
| Code | Description |
|---|---|
| 201 Endpoints | Created |
| 200 Endpoints | OK |
delete Endpoints
+DELETE /api/v1/namespaces/{namespace}/endpoints/{name}
+| Parameter | Description |
|---|---|
name | name of the Endpoints |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of Endpoints
+DELETE /api/v1/namespaces/{namespace}/endpoints
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified Endpoints
+GET /api/v1/namespaces/{namespace}/endpoints/{name}
+| Parameter | Description |
|---|---|
name | name of the Endpoints |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 Endpoints | OK |
list or watch objects of kind Endpoints
+GET /api/v1/namespaces/{namespace}/endpoints
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 EndpointsList | OK |
list or watch objects of kind Endpoints
+GET /api/v1/endpoints
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 EndpointsList | OK |
watch changes to an object of kind Endpoints. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /api/v1/watch/namespaces/{namespace}/endpoints/{name}
+| Parameter | Description |
|---|---|
name | name of the Endpoints |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Endpoints. deprecated: use the 'watch' parameter with a list operation instead.
+GET /api/v1/watch/namespaces/{namespace}/endpoints
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Endpoints. deprecated: use the 'watch' parameter with a list operation instead.
+GET /api/v1/watch/endpoints
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
extensions | v1beta1 | Ingress |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
specIngressSpec | Spec is the desired state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
statusIngressStatus | Status is the current state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
backendIngressBackend | A default backend capable of servicing requests that don't match any rule. At least one of 'backend' or 'rules' must be specified. This field is optional to allow the loadbalancer controller or defaulting logic to specify a global default. |
rulesIngressRule array | A list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend. |
tlsIngressTLS array | TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI. |
| Field | Description |
|---|---|
loadBalancerLoadBalancerStatus | LoadBalancer contains the current status of the load-balancer. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsIngress array | Items is the list of Ingress. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
create an Ingress
+POST /apis/extensions/v1beta1/namespaces/{namespace}/ingresses
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyIngress |
| Code | Description |
|---|---|
| 200 Ingress | OK |
| 201 Ingress | Created |
| 202 Ingress | Accepted |
partially update the specified Ingress
+PATCH /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}
+| Parameter | Description |
|---|---|
name | name of the Ingress |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Ingress | OK |
replace the specified Ingress
+PUT /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}
+| Parameter | Description |
|---|---|
name | name of the Ingress |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyIngress |
| Code | Description |
|---|---|
| 200 Ingress | OK |
| 201 Ingress | Created |
delete an Ingress
+DELETE /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}
+| Parameter | Description |
|---|---|
name | name of the Ingress |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of Ingress
+DELETE /apis/extensions/v1beta1/namespaces/{namespace}/ingresses
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified Ingress
+GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}
+| Parameter | Description |
|---|---|
name | name of the Ingress |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 Ingress | OK |
list or watch objects of kind Ingress
+GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 IngressList | OK |
list or watch objects of kind Ingress
+GET /apis/extensions/v1beta1/ingresses
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 IngressList | OK |
watch changes to an object of kind Ingress. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/ingresses/{name}
+| Parameter | Description |
|---|---|
name | name of the Ingress |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Ingress. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/ingresses
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Ingress. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/extensions/v1beta1/watch/ingresses
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified Ingress
+PATCH /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status
+| Parameter | Description |
|---|---|
name | name of the Ingress |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Ingress | OK |
read status of the specified Ingress
+GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status
+| Parameter | Description |
|---|---|
name | name of the Ingress |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Ingress | OK |
replace status of the specified Ingress
+PUT /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status
+| Parameter | Description |
|---|---|
name | name of the Ingress |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyIngress |
| Code | Description |
|---|---|
| 200 Ingress | OK |
| 201 Ingress | Created |
+kind: Service
+apiVersion: v1
+metadata:
+ # Unique key of the Service instance
+ name: service-example
+spec:
+ ports:
+ # Accept traffic sent to port 80
+ - name: http
+ port: 80
+ targetPort: 80
+ selector:
+ # Loadbalance traffic across Pods matching
+ # this label selector
+ app: nginx
+ # Create an HA proxy in the cloud provider
+ # with an External IP address - *Only supported
+ # by some cloud providers*
+ type: LoadBalancer
+
+
+kind: Service
+apiVersion: v1
+metadata:
+ # Unique key of the Service instance
+ name: service-example
+spec:
+ ports:
+ # Accept traffic sent to port 80
+ - name: http
+ port: 80
+ targetPort: 80
+ selector:
+ # Loadbalance traffic across Pods matching
+ # this label selector
+ app: nginx
+ # Create an HA proxy in the cloud provider
+ # with an External IP address - *Only supported
+ # by some cloud providers*
+ type: LoadBalancer
+
+| Group | Version | Kind |
|---|---|---|
core | v1 | Service |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
specServiceSpec | Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
statusServiceStatus | Most recently observed status of the service. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
clusterIPstring | clusterIP is the IP address of the service and is usually assigned randomly by the master. If an address is specified manually and is not in use by others, it will be allocated to the service; otherwise, creation of the service will fail. This field can not be changed through updates. Valid values are "None", empty string (""), or a valid IP address. "None" can be specified for headless services when proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies |
externalIPsstring array | externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service. These IPs are not managed by Kubernetes. The user is responsible for ensuring that traffic arrives at a node with this IP. A common example is external load-balancers that are not part of the Kubernetes system. |
externalNamestring | externalName is the external reference that kubedns or equivalent will return as a CNAME record for this service. No proxying will be involved. Must be a valid RFC-1123 hostname (https://tools.ietf.org/html/rfc1123) and requires Type to be ExternalName. |
externalTrafficPolicystring | externalTrafficPolicy denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints. "Local" preserves the client source IP and avoids a second hop for LoadBalancer and Nodeport type services, but risks potentially imbalanced traffic spreading. "Cluster" obscures the client source IP and may cause a second hop to another node, but should have good overall load-spreading. |
healthCheckNodePortinteger | healthCheckNodePort specifies the healthcheck nodePort for the service. If not specified, HealthCheckNodePort is created by the service api backend with the allocated nodePort. Will use user-specified nodePort value if specified by the client. Only effects when Type is set to LoadBalancer and ExternalTrafficPolicy is set to Local. |
loadBalancerIPstring | Only applies to Service Type: LoadBalancer LoadBalancer will get created with the IP specified in this field. This feature depends on whether the underlying cloud-provider supports specifying the loadBalancerIP when a load balancer is created. This field will be ignored if the cloud-provider does not support the feature. |
loadBalancerSourceRangesstring array | If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature." More info: https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/ |
portsServicePort array patch strategy: merge patch merge key: port | The list of ports that are exposed by this service. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies |
publishNotReadyAddressesboolean | publishNotReadyAddresses, when set to true, indicates that DNS implementations must publish the notReadyAddresses of subsets for the Endpoints associated with the Service. The default value is false. The primary use case for setting this field is to use a StatefulSet's Headless Service to propagate SRV records for its Pods without respect to their readiness for purpose of peer discovery. |
selectorobject | Route service traffic to pods with label keys and values matching this selector. If empty or not present, the service is assumed to have an external process managing its endpoints, which Kubernetes will not modify. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/ |
sessionAffinitystring | Supports "ClientIP" and "None". Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies |
sessionAffinityConfigSessionAffinityConfig | sessionAffinityConfig contains the configurations of session affinity. |
typestring | type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ExternalName" maps to the specified externalName. "ClusterIP" allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a stable IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the clusterIP. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services---service-types |
| Field | Description |
|---|---|
loadBalancerLoadBalancerStatus | LoadBalancer contains the current status of the load-balancer, if one is present. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsService array | List of services |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
kubectl command
+$ echo 'kind: Service
+apiVersion: v1
+metadata:
+ name: service-example
+spec:
+ ports:
+ - name: http
+ port: 80
+ targetPort: 80
+ selector:
+ app: nginx
+ type: LoadBalancer
+' | kubectl create -f -
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X POST -H 'Content-Type: application/yaml' --data '
+kind: Service
+apiVersion: v1
+metadata:
+ name: service-example
+spec:
+ ports:
+ - name: http
+ port: 80
+ targetPort: 80
+ selector:
+ app: nginx
+ type: LoadBalancer
+' http://127.0.0.1:8001/api/v1/namespaces/default/services
+
+service "service-example" created
+
+{
+ "kind": "Service",
+ "apiVersion": "v1",
+ "metadata": {
+ "name": "service-example",
+ "namespace": "default",
+ "selfLink": "/api/v1/namespaces/default/services/service-example",
+ "uid": "93e5c731-9d30-11e6-9c54-42010a800148",
+ "resourceVersion": "2205767",
+ "creationTimestamp": "2016-10-28T17:04:24Z"
+ },
+ "spec": {
+ "ports": [
+ {
+ "name": "http",
+ "protocol": "TCP",
+ "port": 80,
+ "targetPort": 80,
+ "nodePort": 32417
+ }
+ ],
+ "selector": {
+ "app": "nginx"
+ },
+ "clusterIP": "10.183.250.161",
+ "type": "LoadBalancer",
+ "sessionAffinity": "None"
+ },
+ "status": {
+ "loadBalancer": {}
+ }
+}
+create a Service
+POST /api/v1/namespaces/{namespace}/services
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If IncludeUninitialized is specified, the object may be returned without completing initialization. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyService |
| Code | Description |
|---|---|
| 201 Service | Created |
| 202 Service | Accepted |
| 200 Service | OK |
kubectl command
+$ kubectl patch service -p \
+ '{"spec":{"ports":[{"name":"http","port":80,"targetPort":8080}]}}'
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X PATCH -H 'Content-Type: application/strategic-merge-patch+json' --data '
+{"spec":{"ports":[{"name":"http","port":80,"targetPort":8080}]}}' \
+ 'http://127.0.0.1:8001/api/v1/namespaces/default/services/'
+
+"" patched
+
+{
+ "kind": "Service",
+ "apiVersion": "v1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/api/v1/namespaces/default/services/deployment-example",
+ "uid": "93e5c731-9d30-11e6-9c54-42010a800148",
+ "resourceVersion": "2205995",
+ "creationTimestamp": "2016-10-28T17:04:24Z"
+ },
+ "spec": {
+ "ports": [
+ {
+ "name": "http",
+ "protocol": "TCP",
+ "port": 80,
+ "targetPort": 8080,
+ "nodePort": 32417
+ }
+ ],
+ "selector": {
+ "app": "nginx"
+ },
+ "clusterIP": "10.183.250.161",
+ "type": "LoadBalancer",
+ "sessionAffinity": "None"
+ },
+ "status": {
+ "loadBalancer": {
+ "ingress": [
+ {
+ "ip": "104.198.186.106"
+ }
+ ]
+ }
+ }
+}
+partially update the specified Service
+PATCH /api/v1/namespaces/{namespace}/services/{name}
+| Parameter | Description |
|---|---|
name | name of the Service |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Service | OK |
kubectl command
+$ echo 'apiVersion: v1
+kind: Service
+metadata:
+ name: deployment-example
+ resourceVersion: "2205995"
+spec:
+ clusterIP: 10.183.250.161
+ ports:
+ - name: http
+ nodePort: 32417
+ port: 80
+ protocol: TCP
+ targetPort: 8080
+ selector:
+ app: nginx
+ sessionAffinity: None
+ type: LoadBalancer
+' | kubectl replace -f -
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X PUT -H 'Content-Type: application/yaml' --data '
+apiVersion: v1
+kind: Service
+metadata:
+ name: deployment-example
+ resourceVersion: "2205995"
+spec:
+ clusterIP: 10.183.250.161
+ ports:
+ - name: http
+ nodePort: 32417
+ port: 80
+ protocol: TCP
+ targetPort: 8080
+ selector:
+ app: nginx
+ sessionAffinity: None
+ type: LoadBalancer
+' http://127.0.0.1:8001/api/v1/namespaces/default/services/deployment-example
+
+service "deployment-example" replaced
+
+{
+ "kind": "Service",
+ "apiVersion": "v1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/api/v1/namespaces/default/services/deployment-example",
+ "uid": "93e5c731-9d30-11e6-9c54-42010a800148",
+ "resourceVersion": "2208672",
+ "creationTimestamp": "2016-10-28T17:04:24Z"
+ },
+ "spec": {
+ "ports": [
+ {
+ "name": "http",
+ "protocol": "TCP",
+ "port": 80,
+ "targetPort": 8080,
+ "nodePort": 32417
+ }
+ ],
+ "selector": {
+ "app": "nginx"
+ },
+ "clusterIP": "10.183.250.161",
+ "type": "LoadBalancer",
+ "sessionAffinity": "None"
+ },
+ "status": {
+ "loadBalancer": {
+ "ingress": [
+ {
+ "ip": "104.198.186.106"
+ }
+ ]
+ }
+ }
+}
+replace the specified Service
+PUT /api/v1/namespaces/{namespace}/services/{name}
+| Parameter | Description |
|---|---|
name | name of the Service |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyService |
| Code | Description |
|---|---|
| 200 Service | OK |
| 201 Service | Created |
kubectl command
+$ kubectl delete service deployment-example
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
+gracePeriodSeconds: 0
+orphanDependents: false
+' 'http://127.0.0.1:8001/api/v1/namespaces/default/services/deployment-example'
+
+service "deployment-example" deleted
+
+{
+ "kind": "Status",
+ "apiVersion": "v1",
+ "metadata": {},
+ "status": "Success",
+ "code": 200
+}
+
+delete a Service
+DELETE /api/v1/namespaces/{namespace}/services/{name}
+| Parameter | Description |
|---|---|
name | name of the Service |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 202 Status | Accepted |
| 200 Status | OK |
kubectl command
+$ kubectl get service deployment-example -o json
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X GET http://127.0.0.1:8001/api/v1/namespaces/default/services/deployment-example
+
+{
+ "kind": "Service",
+ "apiVersion": "v1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/api/v1/namespaces/default/services/deployment-example",
+ "uid": "93e5c731-9d30-11e6-9c54-42010a800148",
+ "resourceVersion": "2205995",
+ "creationTimestamp": "2016-10-28T17:04:24Z"
+ },
+ "spec": {
+ "ports": [
+ {
+ "name": "http",
+ "protocol": "TCP",
+ "port": 80,
+ "targetPort": 8080,
+ "nodePort": 32417
+ }
+ ],
+ "selector": {
+ "app": "nginx"
+ },
+ "clusterIP": "10.183.250.161",
+ "type": "LoadBalancer",
+ "sessionAffinity": "None"
+ },
+ "status": {
+ "loadBalancer": {
+ "ingress": [
+ {
+ "ip": "104.198.186.106"
+ }
+ ]
+ }
+ }
+}
+
+{
+ "kind": "Service",
+ "apiVersion": "v1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/api/v1/namespaces/default/services/deployment-example",
+ "uid": "93e5c731-9d30-11e6-9c54-42010a800148",
+ "resourceVersion": "2205995",
+ "creationTimestamp": "2016-10-28T17:04:24Z"
+ },
+ "spec": {
+ "ports": [
+ {
+ "name": "http",
+ "protocol": "TCP",
+ "port": 80,
+ "targetPort": 8080,
+ "nodePort": 32417
+ }
+ ],
+ "selector": {
+ "app": "nginx"
+ },
+ "clusterIP": "10.183.250.161",
+ "type": "LoadBalancer",
+ "sessionAffinity": "None"
+ },
+ "status": {
+ "loadBalancer": {
+ "ingress": [
+ {
+ "ip": "104.198.186.106"
+ }
+ ]
+ }
+ }
+}
+read the specified Service
+GET /api/v1/namespaces/{namespace}/services/{name}
+| Parameter | Description |
|---|---|
name | name of the Service |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 Service | OK |
kubectl command
+$ kubectl get service -o json
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X GET 'http://127.0.0.1:8001/api/v1/namespaces/default/services'
+list or watch objects of kind Service
+GET /api/v1/namespaces/{namespace}/services
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If IncludeUninitialized is specified, the object may be returned without completing initialization. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 ServiceList | OK |
list or watch objects of kind Service
+GET /api/v1/services
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 ServiceList | OK |
kubectl command
+$ kubectl get service deployment-example --watch -o json
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X GET 'http://127.0.0.1:8001/api/v1/watch/namespaces/default/services/deployment-example'
+
+{
+ "type": "ADDED",
+ "object": {
+ "kind": "Service",
+ "apiVersion": "v1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/api/v1/namespaces/default/services/deployment-example",
+ "uid": "93e5c731-9d30-11e6-9c54-42010a800148",
+ "resourceVersion": "2205995",
+ "creationTimestamp": "2016-10-28T17:04:24Z"
+ },
+ "spec": {
+ "ports": [
+ {
+ "name": "http",
+ "protocol": "TCP",
+ "port": 80,
+ "targetPort": 8080,
+ "nodePort": 32417
+ }
+ ],
+ "selector": {
+ "app": "nginx"
+ },
+ "clusterIP": "10.183.250.161",
+ "type": "LoadBalancer",
+ "sessionAffinity": "None"
+ },
+ "status": {
+ "loadBalancer": {
+ "ingress": [
+ {
+ "ip": "104.198.186.106"
+ }
+ ]
+ }
+ }
+ }
+}
+
+{
+ "type": "ADDED",
+ "object": {
+ "kind": "Service",
+ "apiVersion": "v1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/api/v1/namespaces/default/services/deployment-example",
+ "uid": "93e5c731-9d30-11e6-9c54-42010a800148",
+ "resourceVersion": "2205995",
+ "creationTimestamp": "2016-10-28T17:04:24Z"
+ },
+ "spec": {
+ "ports": [
+ {
+ "name": "http",
+ "protocol": "TCP",
+ "port": 80,
+ "targetPort": 8080,
+ "nodePort": 32417
+ }
+ ],
+ "selector": {
+ "app": "nginx"
+ },
+ "clusterIP": "10.183.250.161",
+ "type": "LoadBalancer",
+ "sessionAffinity": "None"
+ },
+ "status": {
+ "loadBalancer": {
+ "ingress": [
+ {
+ "ip": "104.198.186.106"
+ }
+ ]
+ }
+ }
+ }
+}
+watch changes to an object of kind Service. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /api/v1/watch/namespaces/{namespace}/services/{name}
+| Parameter | Description |
|---|---|
name | name of the Service |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Service. deprecated: use the 'watch' parameter with a list operation instead.
+GET /api/v1/watch/namespaces/{namespace}/services
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Service. deprecated: use the 'watch' parameter with a list operation instead.
+GET /api/v1/watch/services
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified Service
+PATCH /api/v1/namespaces/{namespace}/services/{name}/status
+| Parameter | Description |
|---|---|
name | name of the Service |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Service | OK |
read status of the specified Service
+GET /api/v1/namespaces/{namespace}/services/{name}/status
+| Parameter | Description |
|---|---|
name | name of the Service |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Service | OK |
replace status of the specified Service
+PUT /api/v1/namespaces/{namespace}/services/{name}/status
+| Parameter | Description |
|---|---|
name | name of the Service |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyService |
| Code | Description |
|---|---|
| 200 Service | OK |
| 201 Service | Created |
connect POST requests to proxy of Service
+POST /api/v1/namespaces/{namespace}/services/{name}/proxy
+| Parameter | Description |
|---|---|
name | name of the ServiceProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
path | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
| Code | Description |
|---|---|
| 200 string | OK |
connect POST requests to proxy of Service
+POST /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
+| Parameter | Description |
|---|---|
name | name of the ServiceProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
path | path to the resource |
| Parameter | Description |
|---|---|
path | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
| Code | Description |
|---|---|
| 200 string | OK |
connect DELETE requests to proxy of Service
+DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy
+| Parameter | Description |
|---|---|
name | name of the ServiceProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
path | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
| Code | Description |
|---|---|
| 200 string | OK |
connect DELETE requests to proxy of Service
+DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
+| Parameter | Description |
|---|---|
name | name of the ServiceProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
path | path to the resource |
| Parameter | Description |
|---|---|
path | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
| Code | Description |
|---|---|
| 200 string | OK |
connect GET requests to proxy of Service
+GET /api/v1/namespaces/{namespace}/services/{name}/proxy
+| Parameter | Description |
|---|---|
name | name of the ServiceProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
path | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
| Code | Description |
|---|---|
| 200 string | OK |
connect GET requests to proxy of Service
+GET /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
+| Parameter | Description |
|---|---|
name | name of the ServiceProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
path | path to the resource |
| Parameter | Description |
|---|---|
path | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
| Code | Description |
|---|---|
| 200 string | OK |
connect HEAD requests to proxy of Service
+HEAD /api/v1/namespaces/{namespace}/services/{name}/proxy
+| Parameter | Description |
|---|---|
name | name of the ServiceProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
path | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
| Code | Description |
|---|---|
| 200 string | OK |
connect HEAD requests to proxy of Service
+HEAD /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
+| Parameter | Description |
|---|---|
name | name of the ServiceProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
path | path to the resource |
| Parameter | Description |
|---|---|
path | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
| Code | Description |
|---|---|
| 200 string | OK |
connect PUT requests to proxy of Service
+PUT /api/v1/namespaces/{namespace}/services/{name}/proxy
+| Parameter | Description |
|---|---|
name | name of the ServiceProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
path | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
| Code | Description |
|---|---|
| 200 string | OK |
connect PUT requests to proxy of Service
+PUT /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
+| Parameter | Description |
|---|---|
name | name of the ServiceProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
path | path to the resource |
| Parameter | Description |
|---|---|
path | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
| Code | Description |
|---|---|
| 200 string | OK |
| Group | Version | Kind |
|---|---|---|
core | v1 | ConfigMap |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
binaryDataobject | 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. |
dataobject | 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. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsConfigMap array | Items is the list of ConfigMaps. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
create a ConfigMap
+POST /api/v1/namespaces/{namespace}/configmaps
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyConfigMap |
| Code | Description |
|---|---|
| 202 ConfigMap | Accepted |
| 200 ConfigMap | OK |
| 201 ConfigMap | Created |
partially update the specified ConfigMap
+PATCH /api/v1/namespaces/{namespace}/configmaps/{name}
+| Parameter | Description |
|---|---|
name | name of the ConfigMap |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ConfigMap | OK |
replace the specified ConfigMap
+PUT /api/v1/namespaces/{namespace}/configmaps/{name}
+| Parameter | Description |
|---|---|
name | name of the ConfigMap |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyConfigMap |
| Code | Description |
|---|---|
| 200 ConfigMap | OK |
| 201 ConfigMap | Created |
delete a ConfigMap
+DELETE /api/v1/namespaces/{namespace}/configmaps/{name}
+| Parameter | Description |
|---|---|
name | name of the ConfigMap |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of ConfigMap
+DELETE /api/v1/namespaces/{namespace}/configmaps
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified ConfigMap
+GET /api/v1/namespaces/{namespace}/configmaps/{name}
+| Parameter | Description |
|---|---|
name | name of the ConfigMap |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 ConfigMap | OK |
list or watch objects of kind ConfigMap
+GET /api/v1/namespaces/{namespace}/configmaps
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 ConfigMapList | OK |
list or watch objects of kind ConfigMap
+GET /api/v1/configmaps
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 ConfigMapList | OK |
watch changes to an object of kind ConfigMap. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /api/v1/watch/namespaces/{namespace}/configmaps/{name}
+| Parameter | Description |
|---|---|
name | name of the ConfigMap |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ConfigMap. deprecated: use the 'watch' parameter with a list operation instead.
+GET /api/v1/watch/namespaces/{namespace}/configmaps
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ConfigMap. deprecated: use the 'watch' parameter with a list operation instead.
+GET /api/v1/watch/configmaps
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
core | v1 | Secret |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
dataobject | 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 |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
stringDataobject | 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. |
typestring | Used to facilitate programmatic handling of secret data. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsSecret array | Items is a list of secret objects. More info: https://kubernetes.io/docs/concepts/configuration/secret |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
create a Secret
+POST /api/v1/namespaces/{namespace}/secrets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodySecret |
| Code | Description |
|---|---|
| 200 Secret | OK |
| 201 Secret | Created |
| 202 Secret | Accepted |
partially update the specified Secret
+PATCH /api/v1/namespaces/{namespace}/secrets/{name}
+| Parameter | Description |
|---|---|
name | name of the Secret |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Secret | OK |
replace the specified Secret
+PUT /api/v1/namespaces/{namespace}/secrets/{name}
+| Parameter | Description |
|---|---|
name | name of the Secret |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodySecret |
| Code | Description |
|---|---|
| 200 Secret | OK |
| 201 Secret | Created |
delete a Secret
+DELETE /api/v1/namespaces/{namespace}/secrets/{name}
+| Parameter | Description |
|---|---|
name | name of the Secret |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of Secret
+DELETE /api/v1/namespaces/{namespace}/secrets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified Secret
+GET /api/v1/namespaces/{namespace}/secrets/{name}
+| Parameter | Description |
|---|---|
name | name of the Secret |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 Secret | OK |
list or watch objects of kind Secret
+GET /api/v1/namespaces/{namespace}/secrets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 SecretList | OK |
list or watch objects of kind Secret
+GET /api/v1/secrets
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 SecretList | OK |
watch changes to an object of kind Secret. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /api/v1/watch/namespaces/{namespace}/secrets/{name}
+| Parameter | Description |
|---|---|
name | name of the Secret |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Secret. deprecated: use the 'watch' parameter with a list operation instead.
+GET /api/v1/watch/namespaces/{namespace}/secrets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Secret. deprecated: use the 'watch' parameter with a list operation instead.
+GET /api/v1/watch/secrets
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
core | v1 | PersistentVolumeClaim |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
specPersistentVolumeClaimSpec | Spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
statusPersistentVolumeClaimStatus | Status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
| Field | Description |
|---|---|
accessModesstring array | AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
dataSourceTypedLocalObjectReference | This field requires the VolumeSnapshotDataSource alpha feature gate to be enabled and currently VolumeSnapshot is the only supported data source. If the provisioner can support VolumeSnapshot data source, it will create a new volume and data will be restored to the volume at the same time. If the provisioner does not support VolumeSnapshot data source, volume will not be created and the failure will be reported as an event. In the future, we plan to support more data source types and the behavior of the provisioner may change. |
resourcesResourceRequirements | Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources |
selectorLabelSelector | A label query over volumes to consider for binding. |
storageClassNamestring | Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 |
volumeModestring | volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. This is a beta feature. |
volumeNamestring | VolumeName is the binding reference to the PersistentVolume backing this claim. |
| Field | Description |
|---|---|
accessModesstring array | AccessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
capacityobject | Represents the actual resources of the underlying volume. |
conditionsPersistentVolumeClaimCondition array patch strategy: merge patch merge key: type | Current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'. |
phasestring | Phase represents the current phase of PersistentVolumeClaim. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsPersistentVolumeClaim array | A list of persistent volume claims. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
create a PersistentVolumeClaim
+POST /api/v1/namespaces/{namespace}/persistentvolumeclaims
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPersistentVolumeClaim |
| Code | Description |
|---|---|
| 200 PersistentVolumeClaim | OK |
| 201 PersistentVolumeClaim | Created |
| 202 PersistentVolumeClaim | Accepted |
partially update the specified PersistentVolumeClaim
+PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
+| Parameter | Description |
|---|---|
name | name of the PersistentVolumeClaim |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 PersistentVolumeClaim | OK |
replace the specified PersistentVolumeClaim
+PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
+| Parameter | Description |
|---|---|
name | name of the PersistentVolumeClaim |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPersistentVolumeClaim |
| Code | Description |
|---|---|
| 200 PersistentVolumeClaim | OK |
| 201 PersistentVolumeClaim | Created |
delete a PersistentVolumeClaim
+DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
+| Parameter | Description |
|---|---|
name | name of the PersistentVolumeClaim |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 202 Status | Accepted |
| 200 Status | OK |
delete collection of PersistentVolumeClaim
+DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified PersistentVolumeClaim
+GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
+| Parameter | Description |
|---|---|
name | name of the PersistentVolumeClaim |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 PersistentVolumeClaim | OK |
list or watch objects of kind PersistentVolumeClaim
+GET /api/v1/namespaces/{namespace}/persistentvolumeclaims
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 PersistentVolumeClaimList | OK |
list or watch objects of kind PersistentVolumeClaim
+GET /api/v1/persistentvolumeclaims
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 PersistentVolumeClaimList | OK |
watch changes to an object of kind PersistentVolumeClaim. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims/{name}
+| Parameter | Description |
|---|---|
name | name of the PersistentVolumeClaim |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of PersistentVolumeClaim. deprecated: use the 'watch' parameter with a list operation instead.
+GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of PersistentVolumeClaim. deprecated: use the 'watch' parameter with a list operation instead.
+GET /api/v1/watch/persistentvolumeclaims
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified PersistentVolumeClaim
+PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
+| Parameter | Description |
|---|---|
name | name of the PersistentVolumeClaim |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 PersistentVolumeClaim | OK |
read status of the specified PersistentVolumeClaim
+GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
+| Parameter | Description |
|---|---|
name | name of the PersistentVolumeClaim |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 PersistentVolumeClaim | OK |
replace status of the specified PersistentVolumeClaim
+PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
+| Parameter | Description |
|---|---|
name | name of the PersistentVolumeClaim |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPersistentVolumeClaim |
| Code | Description |
|---|---|
| 200 PersistentVolumeClaim | OK |
| 201 PersistentVolumeClaim | Created |
| Group | Version | Kind |
|---|---|---|
storage.k8s.io | v1 | StorageClass |
| Field | Description |
|---|---|
allowVolumeExpansionboolean | AllowVolumeExpansion shows whether the storage class allow volume expand |
allowedTopologiesTopologySelectorTerm array | Restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature. |
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
mountOptionsstring 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. |
parametersobject | Parameters holds the parameters for the provisioner that should create volumes of this storage class. |
provisionerstring | Provisioner indicates the type of the provisioner. |
reclaimPolicystring | Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. Defaults to Delete. |
volumeBindingModestring | VolumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is only honored by servers that enable the VolumeScheduling feature. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsStorageClass array | Items is the list of StorageClasses |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
create a StorageClass
+POST /apis/storage.k8s.io/v1/storageclasses
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyStorageClass |
| Code | Description |
|---|---|
| 200 StorageClass | OK |
| 201 StorageClass | Created |
| 202 StorageClass | Accepted |
partially update the specified StorageClass
+PATCH /apis/storage.k8s.io/v1/storageclasses/{name}
+| Parameter | Description |
|---|---|
name | name of the StorageClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 StorageClass | OK |
replace the specified StorageClass
+PUT /apis/storage.k8s.io/v1/storageclasses/{name}
+| Parameter | Description |
|---|---|
name | name of the StorageClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyStorageClass |
| Code | Description |
|---|---|
| 200 StorageClass | OK |
| 201 StorageClass | Created |
delete a StorageClass
+DELETE /apis/storage.k8s.io/v1/storageclasses/{name}
+| Parameter | Description |
|---|---|
name | name of the StorageClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of StorageClass
+DELETE /apis/storage.k8s.io/v1/storageclasses
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified StorageClass
+GET /apis/storage.k8s.io/v1/storageclasses/{name}
+| Parameter | Description |
|---|---|
name | name of the StorageClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 StorageClass | OK |
list or watch objects of kind StorageClass
+GET /apis/storage.k8s.io/v1/storageclasses
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 StorageClassList | OK |
watch changes to an object of kind StorageClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/storage.k8s.io/v1/watch/storageclasses/{name}
+| Parameter | Description |
|---|---|
name | name of the StorageClass |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of StorageClass. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/storage.k8s.io/v1/watch/storageclasses
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
core | v1 | Volume |
| Field | Description |
|---|---|
awsElasticBlockStoreAWSElasticBlockStoreVolumeSource | AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
azureDiskAzureDiskVolumeSource | AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. |
azureFileAzureFileVolumeSource | AzureFile represents an Azure File Service mount on the host and bind mount to the pod. |
cephfsCephFSVolumeSource | CephFS represents a Ceph FS mount on the host that shares a pod's lifetime |
cinderCinderVolumeSource | Cinder represents a cinder volume attached and mounted on kubelets host machine More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md |
configMapConfigMapVolumeSource | ConfigMap represents a configMap that should populate this volume |
downwardAPIDownwardAPIVolumeSource | DownwardAPI represents downward API about the pod that should populate this volume |
emptyDirEmptyDirVolumeSource | EmptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir |
fcFCVolumeSource | FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. |
flexVolumeFlexVolumeSource | FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. |
flockerFlockerVolumeSource | Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running |
gcePersistentDiskGCEPersistentDiskVolumeSource | GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
gitRepoGitRepoVolumeSource | GitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container. |
glusterfsGlusterfsVolumeSource | Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md |
hostPathHostPathVolumeSource | 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 |
iscsiISCSIVolumeSource | ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://releases.k8s.io/HEAD/examples/volumes/iscsi/README.md |
namestring | Volume's name. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
nfsNFSVolumeSource | NFS represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
persistentVolumeClaimPersistentVolumeClaimVolumeSource | PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
photonPersistentDiskPhotonPersistentDiskVolumeSource | PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine |
portworxVolumePortworxVolumeSource | PortworxVolume represents a portworx volume attached and mounted on kubelets host machine |
projectedProjectedVolumeSource | Items for all in one resources secrets, configmaps, and downward API |
quobyteQuobyteVolumeSource | Quobyte represents a Quobyte mount on the host that shares a pod's lifetime |
rbdRBDVolumeSource | RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md |
scaleIOScaleIOVolumeSource | ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. |
secretSecretVolumeSource | Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret |
storageosStorageOSVolumeSource | StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. |
vsphereVolumeVsphereVirtualDiskVolumeSource | VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine |
| Group | Version | Kind |
|---|---|---|
storage.k8s.io | v1beta1 | VolumeAttachment |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
specVolumeAttachmentSpec | Specification of the desired attach/detach volume behavior. Populated by the Kubernetes system. |
statusVolumeAttachmentStatus | Status of the VolumeAttachment request. Populated by the entity completing the attach or detach operation, i.e. the external-attacher. |
| Field | Description |
|---|---|
attacherstring | Attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName(). |
nodeNamestring | The node that the volume should be attached to. |
sourceVolumeAttachmentSource | Source represents the volume that should be attached. |
| Field | Description |
|---|---|
attachErrorVolumeError | 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. |
attachedboolean | Indicates the volume is successfully attached. This field must only be set by the entity completing the attach operation, i.e. the external-attacher. |
attachmentMetadataobject | 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. |
detachErrorVolumeError | 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. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsVolumeAttachment array | Items is the list of VolumeAttachments |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
create a VolumeAttachment
+POST /apis/storage.k8s.io/v1beta1/volumeattachments
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyVolumeAttachment |
| Code | Description |
|---|---|
| 202 VolumeAttachment | Accepted |
| 200 VolumeAttachment | OK |
| 201 VolumeAttachment | Created |
partially update the specified VolumeAttachment
+PATCH /apis/storage.k8s.io/v1beta1/volumeattachments/{name}
+| Parameter | Description |
|---|---|
name | name of the VolumeAttachment |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 VolumeAttachment | OK |
replace the specified VolumeAttachment
+PUT /apis/storage.k8s.io/v1beta1/volumeattachments/{name}
+| Parameter | Description |
|---|---|
name | name of the VolumeAttachment |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyVolumeAttachment |
| Code | Description |
|---|---|
| 200 VolumeAttachment | OK |
| 201 VolumeAttachment | Created |
delete a VolumeAttachment
+DELETE /apis/storage.k8s.io/v1beta1/volumeattachments/{name}
+| Parameter | Description |
|---|---|
name | name of the VolumeAttachment |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 202 Status | Accepted |
| 200 Status | OK |
delete collection of VolumeAttachment
+DELETE /apis/storage.k8s.io/v1beta1/volumeattachments
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified VolumeAttachment
+GET /apis/storage.k8s.io/v1beta1/volumeattachments/{name}
+| Parameter | Description |
|---|---|
name | name of the VolumeAttachment |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 VolumeAttachment | OK |
list or watch objects of kind VolumeAttachment
+GET /apis/storage.k8s.io/v1beta1/volumeattachments
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 VolumeAttachmentList | OK |
watch changes to an object of kind VolumeAttachment. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/storage.k8s.io/v1beta1/watch/volumeattachments/{name}
+| Parameter | Description |
|---|---|
name | name of the VolumeAttachment |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of VolumeAttachment. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/storage.k8s.io/v1beta1/watch/volumeattachments
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
apps | v1 | ControllerRevision |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
data | Data is the serialized representation of the state. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
revisioninteger | Revision indicates the revision of the state represented by Data. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsControllerRevision array | Items is the list of ControllerRevisions |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
create a ControllerRevision
+POST /apis/apps/v1/namespaces/{namespace}/controllerrevisions
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyControllerRevision |
| Code | Description |
|---|---|
| 200 ControllerRevision | OK |
| 201 ControllerRevision | Created |
| 202 ControllerRevision | Accepted |
partially update the specified ControllerRevision
+PATCH /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}
+| Parameter | Description |
|---|---|
name | name of the ControllerRevision |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ControllerRevision | OK |
replace the specified ControllerRevision
+PUT /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}
+| Parameter | Description |
|---|---|
name | name of the ControllerRevision |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyControllerRevision |
| Code | Description |
|---|---|
| 200 ControllerRevision | OK |
| 201 ControllerRevision | Created |
delete a ControllerRevision
+DELETE /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}
+| Parameter | Description |
|---|---|
name | name of the ControllerRevision |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of ControllerRevision
+DELETE /apis/apps/v1/namespaces/{namespace}/controllerrevisions
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified ControllerRevision
+GET /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}
+| Parameter | Description |
|---|---|
name | name of the ControllerRevision |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 ControllerRevision | OK |
list or watch objects of kind ControllerRevision
+GET /apis/apps/v1/namespaces/{namespace}/controllerrevisions
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 ControllerRevisionList | OK |
list or watch objects of kind ControllerRevision
+GET /apis/apps/v1/controllerrevisions
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 ControllerRevisionList | OK |
watch changes to an object of kind ControllerRevision. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/apps/v1/watch/namespaces/{namespace}/controllerrevisions/{name}
+| Parameter | Description |
|---|---|
name | name of the ControllerRevision |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ControllerRevision. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/apps/v1/watch/namespaces/{namespace}/controllerrevisions
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ControllerRevision. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/apps/v1/watch/controllerrevisions
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
apiextensions.k8s.io | v1beta1 | CustomResourceDefinition |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | |
specCustomResourceDefinitionSpec | Spec describes how the user wants the resources to appear |
statusCustomResourceDefinitionStatus | Status indicates the actual state of the CustomResourceDefinition |
| Field | Description |
|---|---|
additionalPrinterColumnsCustomResourceColumnDefinition array | AdditionalPrinterColumns are additional columns shown e.g. in kubectl next to the name. Defaults to a created-at column. Optional, the global columns for all versions. Top-level and per-version columns are mutually exclusive. |
conversionCustomResourceConversion | `conversion` defines conversion settings for the CRD. |
groupstring | Group is the group this resource belongs in |
namesCustomResourceDefinitionNames | Names are the names used to describe this custom resource |
scopestring | Scope indicates whether this resource is cluster or namespace scoped. Default is namespaced |
subresourcesCustomResourceSubresources | Subresources describes the subresources for CustomResource Optional, the global subresources for all versions. Top-level and per-version subresources are mutually exclusive. |
validationCustomResourceValidation | Validation describes the validation methods for CustomResources Optional, the global validation schema for all versions. Top-level and per-version schemas are mutually exclusive. |
versionstring | Version is the version this resource belongs in Should be always first item in Versions field if provided. Optional, but at least one of Version or Versions must be set. Deprecated: Please use `Versions`. |
versionsCustomResourceDefinitionVersion array | Versions is the list of all supported versions for this resource. If Version field is provided, this field is optional. Validation: All versions must use the same validation schema for now. i.e., top level Validation field is applied to all of these versions. Order: The version name will be used to compute the order. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10. |
| Field | Description |
|---|---|
acceptedNamesCustomResourceDefinitionNames | AcceptedNames are the names that are actually being used to serve discovery They may be different than the names in spec. |
conditionsCustomResourceDefinitionCondition array | Conditions indicate state for particular aspects of a CustomResourceDefinition |
storedVersionsstring array | StoredVersions are all versions of CustomResources that were ever persisted. Tracking these versions allows a migration path for stored versions in etcd. The field is mutable so the migration controller can first finish a migration to another version (i.e. that no old objects are left in the storage), and then remove the rest of the versions from this list. None of the versions in this list can be removed from the spec.Versions field. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsCustomResourceDefinition array | Items individual CustomResourceDefinitions |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta |
create a CustomResourceDefinition
+POST /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyCustomResourceDefinition |
| Code | Description |
|---|---|
| 200 CustomResourceDefinition | OK |
| 201 CustomResourceDefinition | Created |
| 202 CustomResourceDefinition | Accepted |
partially update the specified CustomResourceDefinition
+PATCH /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}
+| Parameter | Description |
|---|---|
name | name of the CustomResourceDefinition |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 CustomResourceDefinition | OK |
replace the specified CustomResourceDefinition
+PUT /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}
+| Parameter | Description |
|---|---|
name | name of the CustomResourceDefinition |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyCustomResourceDefinition |
| Code | Description |
|---|---|
| 200 CustomResourceDefinition | OK |
| 201 CustomResourceDefinition | Created |
delete a CustomResourceDefinition
+DELETE /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}
+| Parameter | Description |
|---|---|
name | name of the CustomResourceDefinition |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of CustomResourceDefinition
+DELETE /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified CustomResourceDefinition
+GET /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}
+| Parameter | Description |
|---|---|
name | name of the CustomResourceDefinition |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 CustomResourceDefinition | OK |
list or watch objects of kind CustomResourceDefinition
+GET /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 CustomResourceDefinitionList | OK |
watch changes to an object of kind CustomResourceDefinition. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/apiextensions.k8s.io/v1beta1/watch/customresourcedefinitions/{name}
+| Parameter | Description |
|---|---|
name | name of the CustomResourceDefinition |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of CustomResourceDefinition. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/apiextensions.k8s.io/v1beta1/watch/customresourcedefinitions
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified CustomResourceDefinition
+PATCH /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}/status
+| Parameter | Description |
|---|---|
name | name of the CustomResourceDefinition |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 CustomResourceDefinition | OK |
read status of the specified CustomResourceDefinition
+GET /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}/status
+| Parameter | Description |
|---|---|
name | name of the CustomResourceDefinition |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 CustomResourceDefinition | OK |
replace status of the specified CustomResourceDefinition
+PUT /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}/status
+| Parameter | Description |
|---|---|
name | name of the CustomResourceDefinition |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyCustomResourceDefinition |
| Code | Description |
|---|---|
| 200 CustomResourceDefinition | OK |
| 201 CustomResourceDefinition | Created |
| Group | Version | Kind |
|---|---|---|
core | v1 | Event |
| Field | Description |
|---|---|
actionstring | What action was taken/failed regarding to the Regarding object. |
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
countinteger | The number of times this event has occurred. |
eventTimeMicroTime | Time when this Event was first observed. |
firstTimestampTime | The time at which the event was first recorded. (Time of server receipt is in TypeMeta.) |
involvedObjectObjectReference | The object that this event is about. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
lastTimestampTime | The time at which the most recent occurrence of this event was recorded. |
messagestring | A human-readable description of the status of this operation. |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
reasonstring | This should be a short, machine understandable string that gives the reason for the transition into the object's current status. |
relatedObjectReference | Optional secondary object for more complex actions. |
reportingComponentstring | Name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`. |
reportingInstancestring | ID of the controller instance, e.g. `kubelet-xyzf`. |
seriesEventSeries | Data about the Event series this event represents or nil if it's a singleton Event. |
sourceEventSource | The component reporting this event. Should be a short machine understandable string. |
typestring | Type of this event (Normal, Warning), new types could be added in the future |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsEvent array | List of events |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
create an Event
+POST /api/v1/namespaces/{namespace}/events
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyEvent |
| Code | Description |
|---|---|
| 202 Event | Accepted |
| 200 Event | OK |
| 201 Event | Created |
partially update the specified Event
+PATCH /api/v1/namespaces/{namespace}/events/{name}
+| Parameter | Description |
|---|---|
name | name of the Event |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Event | OK |
replace the specified Event
+PUT /api/v1/namespaces/{namespace}/events/{name}
+| Parameter | Description |
|---|---|
name | name of the Event |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyEvent |
| Code | Description |
|---|---|
| 200 Event | OK |
| 201 Event | Created |
delete an Event
+DELETE /api/v1/namespaces/{namespace}/events/{name}
+| Parameter | Description |
|---|---|
name | name of the Event |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of Event
+DELETE /api/v1/namespaces/{namespace}/events
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified Event
+GET /api/v1/namespaces/{namespace}/events/{name}
+| Parameter | Description |
|---|---|
name | name of the Event |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 Event | OK |
list or watch objects of kind Event
+GET /api/v1/namespaces/{namespace}/events
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 EventList | OK |
list or watch objects of kind Event
+GET /api/v1/events
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 EventList | OK |
watch changes to an object of kind Event. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /api/v1/watch/namespaces/{namespace}/events/{name}
+| Parameter | Description |
|---|---|
name | name of the Event |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead.
+GET /api/v1/watch/namespaces/{namespace}/events
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead.
+GET /api/v1/watch/events
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
core | v1 | LimitRange |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
specLimitRangeSpec | Spec defines the limits enforced. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
limitsLimitRangeItem array | Limits is the list of LimitRangeItem objects that are enforced. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsLimitRange array | Items is a list of LimitRange objects. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
create a LimitRange
+POST /api/v1/namespaces/{namespace}/limitranges
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyLimitRange |
| Code | Description |
|---|---|
| 202 LimitRange | Accepted |
| 200 LimitRange | OK |
| 201 LimitRange | Created |
partially update the specified LimitRange
+PATCH /api/v1/namespaces/{namespace}/limitranges/{name}
+| Parameter | Description |
|---|---|
name | name of the LimitRange |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 LimitRange | OK |
replace the specified LimitRange
+PUT /api/v1/namespaces/{namespace}/limitranges/{name}
+| Parameter | Description |
|---|---|
name | name of the LimitRange |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyLimitRange |
| Code | Description |
|---|---|
| 200 LimitRange | OK |
| 201 LimitRange | Created |
delete a LimitRange
+DELETE /api/v1/namespaces/{namespace}/limitranges/{name}
+| Parameter | Description |
|---|---|
name | name of the LimitRange |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 202 Status | Accepted |
| 200 Status | OK |
delete collection of LimitRange
+DELETE /api/v1/namespaces/{namespace}/limitranges
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified LimitRange
+GET /api/v1/namespaces/{namespace}/limitranges/{name}
+| Parameter | Description |
|---|---|
name | name of the LimitRange |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 LimitRange | OK |
list or watch objects of kind LimitRange
+GET /api/v1/namespaces/{namespace}/limitranges
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 LimitRangeList | OK |
list or watch objects of kind LimitRange
+GET /api/v1/limitranges
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 LimitRangeList | OK |
watch changes to an object of kind LimitRange. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /api/v1/watch/namespaces/{namespace}/limitranges/{name}
+| Parameter | Description |
|---|---|
name | name of the LimitRange |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of LimitRange. deprecated: use the 'watch' parameter with a list operation instead.
+GET /api/v1/watch/namespaces/{namespace}/limitranges
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of LimitRange. deprecated: use the 'watch' parameter with a list operation instead.
+GET /api/v1/watch/limitranges
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
autoscaling | v1 | HorizontalPodAutoscaler |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
specHorizontalPodAutoscalerSpec | behaviour of autoscaler. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. |
statusHorizontalPodAutoscalerStatus | current information about the autoscaler. |
| Field | Description |
|---|---|
maxReplicasinteger | upper limit for the number of pods that can be set by the autoscaler; cannot be smaller than MinReplicas. |
minReplicasinteger | lower limit for the number of pods that can be set by the autoscaler, default 1. |
scaleTargetRefCrossVersionObjectReference | 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. |
targetCPUUtilizationPercentageinteger | 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. |
| Field | Description |
|---|---|
currentCPUUtilizationPercentageinteger | 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. |
currentReplicasinteger | current number of replicas of pods managed by this autoscaler. |
desiredReplicasinteger | desired number of replicas of pods managed by this autoscaler. |
lastScaleTimeTime | last time the HorizontalPodAutoscaler scaled the number of pods; used by the autoscaler to control how often the number of pods is changed. |
observedGenerationinteger | most recent generation observed by this autoscaler. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsHorizontalPodAutoscaler array | list of horizontal pod autoscaler objects. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. |
create a HorizontalPodAutoscaler
+POST /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyHorizontalPodAutoscaler |
| Code | Description |
|---|---|
| 202 HorizontalPodAutoscaler | Accepted |
| 200 HorizontalPodAutoscaler | OK |
| 201 HorizontalPodAutoscaler | Created |
partially update the specified HorizontalPodAutoscaler
+PATCH /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}
+| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
replace the specified HorizontalPodAutoscaler
+PUT /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}
+| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyHorizontalPodAutoscaler |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
| 201 HorizontalPodAutoscaler | Created |
delete a HorizontalPodAutoscaler
+DELETE /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}
+| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of HorizontalPodAutoscaler
+DELETE /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified HorizontalPodAutoscaler
+GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}
+| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
list or watch objects of kind HorizontalPodAutoscaler
+GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscalerList | OK |
list or watch objects of kind HorizontalPodAutoscaler
+GET /apis/autoscaling/v1/horizontalpodautoscalers
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscalerList | OK |
watch changes to an object of kind HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/autoscaling/v1/watch/namespaces/{namespace}/horizontalpodautoscalers/{name}
+| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/autoscaling/v1/watch/namespaces/{namespace}/horizontalpodautoscalers
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/autoscaling/v1/watch/horizontalpodautoscalers
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified HorizontalPodAutoscaler
+PATCH /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
+| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
read status of the specified HorizontalPodAutoscaler
+GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
+| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
replace status of the specified HorizontalPodAutoscaler
+PUT /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
+| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyHorizontalPodAutoscaler |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
| 201 HorizontalPodAutoscaler | Created |
| Group | Version | Kind |
|---|---|---|
admissionregistration.k8s.io | v1alpha1 | InitializerConfiguration |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
initializersInitializer array patch strategy: 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. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsInitializerConfiguration array | List of InitializerConfiguration. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
create an InitializerConfiguration
+POST /apis/admissionregistration.k8s.io/v1alpha1/initializerconfigurations
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyInitializerConfiguration |
| Code | Description |
|---|---|
| 200 InitializerConfiguration | OK |
| 201 InitializerConfiguration | Created |
| 202 InitializerConfiguration | Accepted |
partially update the specified InitializerConfiguration
+PATCH /apis/admissionregistration.k8s.io/v1alpha1/initializerconfigurations/{name}
+| Parameter | Description |
|---|---|
name | name of the InitializerConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 InitializerConfiguration | OK |
replace the specified InitializerConfiguration
+PUT /apis/admissionregistration.k8s.io/v1alpha1/initializerconfigurations/{name}
+| Parameter | Description |
|---|---|
name | name of the InitializerConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyInitializerConfiguration |
| Code | Description |
|---|---|
| 200 InitializerConfiguration | OK |
| 201 InitializerConfiguration | Created |
delete an InitializerConfiguration
+DELETE /apis/admissionregistration.k8s.io/v1alpha1/initializerconfigurations/{name}
+| Parameter | Description |
|---|---|
name | name of the InitializerConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of InitializerConfiguration
+DELETE /apis/admissionregistration.k8s.io/v1alpha1/initializerconfigurations
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified InitializerConfiguration
+GET /apis/admissionregistration.k8s.io/v1alpha1/initializerconfigurations/{name}
+| Parameter | Description |
|---|---|
name | name of the InitializerConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 InitializerConfiguration | OK |
list or watch objects of kind InitializerConfiguration
+GET /apis/admissionregistration.k8s.io/v1alpha1/initializerconfigurations
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 InitializerConfigurationList | OK |
watch changes to an object of kind InitializerConfiguration. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/admissionregistration.k8s.io/v1alpha1/watch/initializerconfigurations/{name}
+| Parameter | Description |
|---|---|
name | name of the InitializerConfiguration |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of InitializerConfiguration. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/admissionregistration.k8s.io/v1alpha1/watch/initializerconfigurations
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
admissionregistration.k8s.io | v1beta1 | MutatingWebhookConfiguration |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata. |
webhooksWebhook array patch strategy: merge patch merge key: name | Webhooks is a list of webhooks and the affected resources and operations. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsMutatingWebhookConfiguration array | List of MutatingWebhookConfiguration. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
create a MutatingWebhookConfiguration
+POST /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyMutatingWebhookConfiguration |
| Code | Description |
|---|---|
| 200 MutatingWebhookConfiguration | OK |
| 201 MutatingWebhookConfiguration | Created |
| 202 MutatingWebhookConfiguration | Accepted |
partially update the specified MutatingWebhookConfiguration
+PATCH /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations/{name}
+| Parameter | Description |
|---|---|
name | name of the MutatingWebhookConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 MutatingWebhookConfiguration | OK |
replace the specified MutatingWebhookConfiguration
+PUT /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations/{name}
+| Parameter | Description |
|---|---|
name | name of the MutatingWebhookConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyMutatingWebhookConfiguration |
| Code | Description |
|---|---|
| 200 MutatingWebhookConfiguration | OK |
| 201 MutatingWebhookConfiguration | Created |
delete a MutatingWebhookConfiguration
+DELETE /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations/{name}
+| Parameter | Description |
|---|---|
name | name of the MutatingWebhookConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 202 Status | Accepted |
| 200 Status | OK |
delete collection of MutatingWebhookConfiguration
+DELETE /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified MutatingWebhookConfiguration
+GET /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations/{name}
+| Parameter | Description |
|---|---|
name | name of the MutatingWebhookConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 MutatingWebhookConfiguration | OK |
list or watch objects of kind MutatingWebhookConfiguration
+GET /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 MutatingWebhookConfigurationList | OK |
watch changes to an object of kind MutatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/admissionregistration.k8s.io/v1beta1/watch/mutatingwebhookconfigurations/{name}
+| Parameter | Description |
|---|---|
name | name of the MutatingWebhookConfiguration |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of MutatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/admissionregistration.k8s.io/v1beta1/watch/mutatingwebhookconfigurations
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
admissionregistration.k8s.io | v1beta1 | ValidatingWebhookConfiguration |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata. |
webhooksWebhook array patch strategy: merge patch merge key: name | Webhooks is a list of webhooks and the affected resources and operations. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsValidatingWebhookConfiguration array | List of ValidatingWebhookConfiguration. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
create a ValidatingWebhookConfiguration
+POST /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyValidatingWebhookConfiguration |
| Code | Description |
|---|---|
| 200 ValidatingWebhookConfiguration | OK |
| 201 ValidatingWebhookConfiguration | Created |
| 202 ValidatingWebhookConfiguration | Accepted |
partially update the specified ValidatingWebhookConfiguration
+PATCH /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations/{name}
+| Parameter | Description |
|---|---|
name | name of the ValidatingWebhookConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ValidatingWebhookConfiguration | OK |
replace the specified ValidatingWebhookConfiguration
+PUT /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations/{name}
+| Parameter | Description |
|---|---|
name | name of the ValidatingWebhookConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyValidatingWebhookConfiguration |
| Code | Description |
|---|---|
| 200 ValidatingWebhookConfiguration | OK |
| 201 ValidatingWebhookConfiguration | Created |
delete a ValidatingWebhookConfiguration
+DELETE /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations/{name}
+| Parameter | Description |
|---|---|
name | name of the ValidatingWebhookConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of ValidatingWebhookConfiguration
+DELETE /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified ValidatingWebhookConfiguration
+GET /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations/{name}
+| Parameter | Description |
|---|---|
name | name of the ValidatingWebhookConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 ValidatingWebhookConfiguration | OK |
list or watch objects of kind ValidatingWebhookConfiguration
+GET /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 ValidatingWebhookConfigurationList | OK |
watch changes to an object of kind ValidatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/admissionregistration.k8s.io/v1beta1/watch/validatingwebhookconfigurations/{name}
+| Parameter | Description |
|---|---|
name | name of the ValidatingWebhookConfiguration |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ValidatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/admissionregistration.k8s.io/v1beta1/watch/validatingwebhookconfigurations
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
core | v1 | PodTemplate |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
templatePodTemplateSpec | Template defines the pods that will be created from this pod template. https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
specPodSpec | Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsPodTemplate array | List of pod templates |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
create a PodTemplate
+POST /api/v1/namespaces/{namespace}/podtemplates
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPodTemplate |
| Code | Description |
|---|---|
| 200 PodTemplate | OK |
| 201 PodTemplate | Created |
| 202 PodTemplate | Accepted |
partially update the specified PodTemplate
+PATCH /api/v1/namespaces/{namespace}/podtemplates/{name}
+| Parameter | Description |
|---|---|
name | name of the PodTemplate |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 PodTemplate | OK |
replace the specified PodTemplate
+PUT /api/v1/namespaces/{namespace}/podtemplates/{name}
+| Parameter | Description |
|---|---|
name | name of the PodTemplate |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPodTemplate |
| Code | Description |
|---|---|
| 200 PodTemplate | OK |
| 201 PodTemplate | Created |
delete a PodTemplate
+DELETE /api/v1/namespaces/{namespace}/podtemplates/{name}
+| Parameter | Description |
|---|---|
name | name of the PodTemplate |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of PodTemplate
+DELETE /api/v1/namespaces/{namespace}/podtemplates
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified PodTemplate
+GET /api/v1/namespaces/{namespace}/podtemplates/{name}
+| Parameter | Description |
|---|---|
name | name of the PodTemplate |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 PodTemplate | OK |
list or watch objects of kind PodTemplate
+GET /api/v1/namespaces/{namespace}/podtemplates
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 PodTemplateList | OK |
list or watch objects of kind PodTemplate
+GET /api/v1/podtemplates
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 PodTemplateList | OK |
watch changes to an object of kind PodTemplate. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /api/v1/watch/namespaces/{namespace}/podtemplates/{name}
+| Parameter | Description |
|---|---|
name | name of the PodTemplate |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of PodTemplate. deprecated: use the 'watch' parameter with a list operation instead.
+GET /api/v1/watch/namespaces/{namespace}/podtemplates
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of PodTemplate. deprecated: use the 'watch' parameter with a list operation instead.
+GET /api/v1/watch/podtemplates
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
policy | v1beta1 | PodDisruptionBudget |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | |
specPodDisruptionBudgetSpec | Specification of the desired behavior of the PodDisruptionBudget. |
statusPodDisruptionBudgetStatus | Most recently observed status of the PodDisruptionBudget. |
| Field | 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%". |
selectorLabelSelector | Label query over pods whose evictions are managed by the disruption budget. |
| Field | Description |
|---|---|
currentHealthyinteger | current number of healthy pods |
desiredHealthyinteger | minimum desired number of healthy pods |
disruptedPodsobject | 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. |
disruptionsAllowedinteger | Number of pod disruptions that are currently allowed. |
expectedPodsinteger | total number of pods counted by this disruption budget |
observedGenerationinteger | 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. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsPodDisruptionBudget array | |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta |
create a PodDisruptionBudget
+POST /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPodDisruptionBudget |
| Code | Description |
|---|---|
| 200 PodDisruptionBudget | OK |
| 201 PodDisruptionBudget | Created |
| 202 PodDisruptionBudget | Accepted |
partially update the specified PodDisruptionBudget
+PATCH /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}
+| Parameter | Description |
|---|---|
name | name of the PodDisruptionBudget |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 PodDisruptionBudget | OK |
replace the specified PodDisruptionBudget
+PUT /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}
+| Parameter | Description |
|---|---|
name | name of the PodDisruptionBudget |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPodDisruptionBudget |
| Code | Description |
|---|---|
| 200 PodDisruptionBudget | OK |
| 201 PodDisruptionBudget | Created |
delete a PodDisruptionBudget
+DELETE /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}
+| Parameter | Description |
|---|---|
name | name of the PodDisruptionBudget |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 202 Status | Accepted |
| 200 Status | OK |
delete collection of PodDisruptionBudget
+DELETE /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified PodDisruptionBudget
+GET /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}
+| Parameter | Description |
|---|---|
name | name of the PodDisruptionBudget |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 PodDisruptionBudget | OK |
list or watch objects of kind PodDisruptionBudget
+GET /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 PodDisruptionBudgetList | OK |
list or watch objects of kind PodDisruptionBudget
+GET /apis/policy/v1beta1/poddisruptionbudgets
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 PodDisruptionBudgetList | OK |
watch changes to an object of kind PodDisruptionBudget. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/policy/v1beta1/watch/namespaces/{namespace}/poddisruptionbudgets/{name}
+| Parameter | Description |
|---|---|
name | name of the PodDisruptionBudget |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of PodDisruptionBudget. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/policy/v1beta1/watch/namespaces/{namespace}/poddisruptionbudgets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of PodDisruptionBudget. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/policy/v1beta1/watch/poddisruptionbudgets
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified PodDisruptionBudget
+PATCH /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}/status
+| Parameter | Description |
|---|---|
name | name of the PodDisruptionBudget |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 PodDisruptionBudget | OK |
read status of the specified PodDisruptionBudget
+GET /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}/status
+| Parameter | Description |
|---|---|
name | name of the PodDisruptionBudget |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 PodDisruptionBudget | OK |
replace status of the specified PodDisruptionBudget
+PUT /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}/status
+| Parameter | Description |
|---|---|
name | name of the PodDisruptionBudget |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPodDisruptionBudget |
| Code | Description |
|---|---|
| 200 PodDisruptionBudget | OK |
| 201 PodDisruptionBudget | Created |
| Group | Version | Kind |
|---|---|---|
scheduling.k8s.io | v1beta1 | PriorityClass |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
descriptionstring | description is an arbitrary string that usually provides guidelines on when this priority class should be used. |
globalDefaultboolean | 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. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
valueinteger | The value of this priority class. This is the actual priority that pods receive when they have the name of this class in their pod spec. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsPriorityClass array | items is the list of PriorityClasses |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
create a PriorityClass
+POST /apis/scheduling.k8s.io/v1beta1/priorityclasses
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPriorityClass |
| Code | Description |
|---|---|
| 200 PriorityClass | OK |
| 201 PriorityClass | Created |
| 202 PriorityClass | Accepted |
partially update the specified PriorityClass
+PATCH /apis/scheduling.k8s.io/v1beta1/priorityclasses/{name}
+| Parameter | Description |
|---|---|
name | name of the PriorityClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 PriorityClass | OK |
replace the specified PriorityClass
+PUT /apis/scheduling.k8s.io/v1beta1/priorityclasses/{name}
+| Parameter | Description |
|---|---|
name | name of the PriorityClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPriorityClass |
| Code | Description |
|---|---|
| 200 PriorityClass | OK |
| 201 PriorityClass | Created |
delete a PriorityClass
+DELETE /apis/scheduling.k8s.io/v1beta1/priorityclasses/{name}
+| Parameter | Description |
|---|---|
name | name of the PriorityClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of PriorityClass
+DELETE /apis/scheduling.k8s.io/v1beta1/priorityclasses
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified PriorityClass
+GET /apis/scheduling.k8s.io/v1beta1/priorityclasses/{name}
+| Parameter | Description |
|---|---|
name | name of the PriorityClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 PriorityClass | OK |
list or watch objects of kind PriorityClass
+GET /apis/scheduling.k8s.io/v1beta1/priorityclasses
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 PriorityClassList | OK |
watch changes to an object of kind PriorityClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/scheduling.k8s.io/v1beta1/watch/priorityclasses/{name}
+| Parameter | Description |
|---|---|
name | name of the PriorityClass |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of PriorityClass. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/scheduling.k8s.io/v1beta1/watch/priorityclasses
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
settings.k8s.io | v1alpha1 | PodPreset |
Warning:
Alpha objects should not be used in production and may not be compatible with future versions of the resource type.
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | |
specPodPresetSpec |
| Field | Description |
|---|---|
envEnvVar array | Env defines the collection of EnvVar to inject into containers. |
envFromEnvFromSource array | EnvFrom defines the collection of EnvFromSource to inject into containers. |
selectorLabelSelector | Selector is a label query over a set of resources, in this case pods. Required. |
volumeMountsVolumeMount array | VolumeMounts defines the collection of VolumeMount to inject into containers. |
volumesVolume array | Volumes defines the collection of Volume to inject into the pod. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsPodPreset array | Items is a list of schema objects. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
create a PodPreset
+POST /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPodPreset |
| Code | Description |
|---|---|
| 202 PodPreset | Accepted |
| 200 PodPreset | OK |
| 201 PodPreset | Created |
partially update the specified PodPreset
+PATCH /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets/{name}
+| Parameter | Description |
|---|---|
name | name of the PodPreset |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 PodPreset | OK |
replace the specified PodPreset
+PUT /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets/{name}
+| Parameter | Description |
|---|---|
name | name of the PodPreset |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPodPreset |
| Code | Description |
|---|---|
| 200 PodPreset | OK |
| 201 PodPreset | Created |
delete a PodPreset
+DELETE /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets/{name}
+| Parameter | Description |
|---|---|
name | name of the PodPreset |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of PodPreset
+DELETE /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified PodPreset
+GET /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets/{name}
+| Parameter | Description |
|---|---|
name | name of the PodPreset |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 PodPreset | OK |
list or watch objects of kind PodPreset
+GET /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 PodPresetList | OK |
list or watch objects of kind PodPreset
+GET /apis/settings.k8s.io/v1alpha1/podpresets
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 PodPresetList | OK |
watch changes to an object of kind PodPreset. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/settings.k8s.io/v1alpha1/watch/namespaces/{namespace}/podpresets/{name}
+| Parameter | Description |
|---|---|
name | name of the PodPreset |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of PodPreset. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/settings.k8s.io/v1alpha1/watch/namespaces/{namespace}/podpresets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of PodPreset. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/settings.k8s.io/v1alpha1/watch/podpresets
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
extensions | v1beta1 | PodSecurityPolicy |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
specPodSecurityPolicySpec | spec defines the policy enforced. |
| Field | Description |
|---|---|
allowPrivilegeEscalationboolean | allowPrivilegeEscalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true. |
allowedCapabilitiesstring 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. |
allowedFlexVolumesAllowedFlexVolume array | 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. |
allowedHostPathsAllowedHostPath array | allowedHostPaths is a white list of allowed host paths. Empty indicates that all host paths may be used. |
allowedProcMountTypesstring array | AllowedProcMountTypes is a whitelist of allowed ProcMountTypes. Empty or nil indicates that only the DefaultProcMountType may be used. This requires the ProcMountType feature flag to be enabled. |
allowedUnsafeSysctlsstring array | allowedUnsafeSysctls is a list of explicitly allowed unsafe sysctls, defaults to none. Each entry is either a plain sysctl name or ends in "*" in which case it is considered as a prefix of allowed sysctls. Single * means all unsafe sysctls are allowed. Kubelet has to whitelist all allowed unsafe sysctls explicitly to avoid rejection. Examples: e.g. "foo/*" allows "foo/bar", "foo/baz", etc. e.g. "foo.*" allows "foo.bar", "foo.baz", etc. |
defaultAddCapabilitiesstring 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. |
defaultAllowPrivilegeEscalationboolean | defaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process. |
forbiddenSysctlsstring array | forbiddenSysctls is a list of explicitly forbidden sysctls, defaults to none. Each entry is either a plain sysctl name or ends in "*" in which case it is considered as a prefix of forbidden sysctls. Single * means all sysctls are forbidden. Examples: e.g. "foo/*" forbids "foo/bar", "foo/baz", etc. e.g. "foo.*" forbids "foo.bar", "foo.baz", etc. |
fsGroupFSGroupStrategyOptions | fsGroup is the strategy that will dictate what fs group is used by the SecurityContext. |
hostIPCboolean | hostIPC determines if the policy allows the use of HostIPC in the pod spec. |
hostNetworkboolean | hostNetwork determines if the policy allows the use of HostNetwork in the pod spec. |
hostPIDboolean | hostPID determines if the policy allows the use of HostPID in the pod spec. |
hostPortsHostPortRange array | hostPorts determines which host port ranges are allowed to be exposed. |
privilegedboolean | privileged determines if a pod can request to be run as privileged. |
readOnlyRootFilesystemboolean | 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. |
requiredDropCapabilitiesstring array | requiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added. |
runAsGroupRunAsGroupStrategyOptions | RunAsGroup is the strategy that will dictate the allowable RunAsGroup values that may be set. If this field is omitted, the pod's RunAsGroup can take any value. This field requires the RunAsGroup feature gate to be enabled. |
runAsUserRunAsUserStrategyOptions | runAsUser is the strategy that will dictate the allowable RunAsUser values that may be set. |
seLinuxSELinuxStrategyOptions | seLinux is the strategy that will dictate the allowable labels that may be set. |
supplementalGroupsSupplementalGroupsStrategyOptions | supplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext. |
volumesstring array | volumes is a white list of allowed volume plugins. Empty indicates that no volumes may be used. To allow all volumes you may use '\*'. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsPodSecurityPolicy array | items is a list of schema objects. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
create a PodSecurityPolicy
+POST /apis/extensions/v1beta1/podsecuritypolicies
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPodSecurityPolicy |
| Code | Description |
|---|---|
| 202 PodSecurityPolicy | Accepted |
| 200 PodSecurityPolicy | OK |
| 201 PodSecurityPolicy | Created |
partially update the specified PodSecurityPolicy
+PATCH /apis/extensions/v1beta1/podsecuritypolicies/{name}
+| Parameter | Description |
|---|---|
name | name of the PodSecurityPolicy |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 PodSecurityPolicy | OK |
replace the specified PodSecurityPolicy
+PUT /apis/extensions/v1beta1/podsecuritypolicies/{name}
+| Parameter | Description |
|---|---|
name | name of the PodSecurityPolicy |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPodSecurityPolicy |
| Code | Description |
|---|---|
| 200 PodSecurityPolicy | OK |
| 201 PodSecurityPolicy | Created |
delete a PodSecurityPolicy
+DELETE /apis/extensions/v1beta1/podsecuritypolicies/{name}
+| Parameter | Description |
|---|---|
name | name of the PodSecurityPolicy |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of PodSecurityPolicy
+DELETE /apis/extensions/v1beta1/podsecuritypolicies
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified PodSecurityPolicy
+GET /apis/extensions/v1beta1/podsecuritypolicies/{name}
+| Parameter | Description |
|---|---|
name | name of the PodSecurityPolicy |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 PodSecurityPolicy | OK |
list or watch objects of kind PodSecurityPolicy
+GET /apis/extensions/v1beta1/podsecuritypolicies
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 PodSecurityPolicyList | OK |
watch changes to an object of kind PodSecurityPolicy. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/extensions/v1beta1/watch/podsecuritypolicies/{name}
+| Parameter | Description |
|---|---|
name | name of the PodSecurityPolicy |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of PodSecurityPolicy. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/extensions/v1beta1/watch/podsecuritypolicies
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
apiregistration.k8s.io | v1 | APIService |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | |
specAPIServiceSpec | Spec contains information for locating and communicating with a server |
statusAPIServiceStatus | Status contains derived information about an API server |
| Field | Description |
|---|---|
caBundlestring | CABundle is a PEM encoded CA bundle which will be used to validate an API server's serving certificate. If unspecified, system trust roots on the apiserver are used. |
groupstring | Group is the API group name this server hosts |
groupPriorityMinimuminteger | 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 |
insecureSkipTLSVerifyboolean | InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. This is strongly discouraged. You should use the CABundle instead. |
serviceServiceReference | 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. |
versionstring | Version is the API version this server hosts. For example, "v1" |
versionPriorityinteger | 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). Since it's inside of a group, the number can be small, probably in the 10s. In case of equal version priorities, the version string will be used to compute the order inside a group. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10. |
| Field | Description |
|---|---|
conditionsAPIServiceCondition array patch strategy: merge patch merge key: type | Current service state of apiService. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsAPIService array | |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta |
create an APIService
+POST /apis/apiregistration.k8s.io/v1/apiservices
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyAPIService |
| Code | Description |
|---|---|
| 202 APIService | Accepted |
| 200 APIService | OK |
| 201 APIService | Created |
partially update the specified APIService
+PATCH /apis/apiregistration.k8s.io/v1/apiservices/{name}
+| Parameter | Description |
|---|---|
name | name of the APIService |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 APIService | OK |
replace the specified APIService
+PUT /apis/apiregistration.k8s.io/v1/apiservices/{name}
+| Parameter | Description |
|---|---|
name | name of the APIService |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyAPIService |
| Code | Description |
|---|---|
| 200 APIService | OK |
| 201 APIService | Created |
delete an APIService
+DELETE /apis/apiregistration.k8s.io/v1/apiservices/{name}
+| Parameter | Description |
|---|---|
name | name of the APIService |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of APIService
+DELETE /apis/apiregistration.k8s.io/v1/apiservices
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified APIService
+GET /apis/apiregistration.k8s.io/v1/apiservices/{name}
+| Parameter | Description |
|---|---|
name | name of the APIService |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 APIService | OK |
list or watch objects of kind APIService
+GET /apis/apiregistration.k8s.io/v1/apiservices
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 APIServiceList | OK |
watch changes to an object of kind APIService. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/apiregistration.k8s.io/v1/watch/apiservices/{name}
+| Parameter | Description |
|---|---|
name | name of the APIService |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of APIService. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/apiregistration.k8s.io/v1/watch/apiservices
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified APIService
+PATCH /apis/apiregistration.k8s.io/v1/apiservices/{name}/status
+| Parameter | Description |
|---|---|
name | name of the APIService |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 APIService | OK |
read status of the specified APIService
+GET /apis/apiregistration.k8s.io/v1/apiservices/{name}/status
+| Parameter | Description |
|---|---|
name | name of the APIService |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 APIService | OK |
replace status of the specified APIService
+PUT /apis/apiregistration.k8s.io/v1/apiservices/{name}/status
+| Parameter | Description |
|---|---|
name | name of the APIService |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyAPIService |
| Code | Description |
|---|---|
| 200 APIService | OK |
| 201 APIService | Created |
| Group | Version | Kind |
|---|---|---|
core | v1 | Binding |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
targetObjectReference | The target object that you want to bind to the standard object. |
create a Binding
+POST /api/v1/namespaces/{namespace}/bindings
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
includeUninitialized | If IncludeUninitialized is specified, the object may be returned without completing initialization. |
pretty | If 'true', then the output is pretty printed. |
| Parameter | Description |
|---|---|
bodyBinding |
| Code | Description |
|---|---|
| 201 Binding | Created |
| 202 Binding | Accepted |
| 200 Binding | OK |
| Group | Version | Kind |
|---|---|---|
certificates.k8s.io | v1beta1 | CertificateSigningRequest |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | |
specCertificateSigningRequestSpec | The certificate request itself and any additional information. |
statusCertificateSigningRequestStatus | Derived information about the request. |
| Field | Description |
|---|---|
extraobject | Extra information about the requesting user. See user.Info interface for details. |
groupsstring array | Group information about the requesting user. See user.Info interface for details. |
requeststring | Base64-encoded PKCS#10 CSR data |
uidstring | UID information about the requesting user. See user.Info interface for details. |
usagesstring array | allowedUsages specifies a set of usage contexts the key will be valid for. See: https://tools.ietf.org/html/rfc5280#section-4.2.1.3 https://tools.ietf.org/html/rfc5280#section-4.2.1.12 |
usernamestring | Information about the requesting user. See user.Info interface for details. |
| Field | Description |
|---|---|
certificatestring | If request was approved, the controller will place the issued certificate here. |
conditionsCertificateSigningRequestCondition array | Conditions applied to the request, such as approval or denial. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsCertificateSigningRequest array | |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta |
create a CertificateSigningRequest
+POST /apis/certificates.k8s.io/v1beta1/certificatesigningrequests
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyCertificateSigningRequest |
| Code | Description |
|---|---|
| 201 CertificateSigningRequest | Created |
| 202 CertificateSigningRequest | Accepted |
| 200 CertificateSigningRequest | OK |
partially update the specified CertificateSigningRequest
+PATCH /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}
+| Parameter | Description |
|---|---|
name | name of the CertificateSigningRequest |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 CertificateSigningRequest | OK |
replace the specified CertificateSigningRequest
+PUT /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}
+| Parameter | Description |
|---|---|
name | name of the CertificateSigningRequest |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyCertificateSigningRequest |
| Code | Description |
|---|---|
| 200 CertificateSigningRequest | OK |
| 201 CertificateSigningRequest | Created |
delete a CertificateSigningRequest
+DELETE /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}
+| Parameter | Description |
|---|---|
name | name of the CertificateSigningRequest |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of CertificateSigningRequest
+DELETE /apis/certificates.k8s.io/v1beta1/certificatesigningrequests
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified CertificateSigningRequest
+GET /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}
+| Parameter | Description |
|---|---|
name | name of the CertificateSigningRequest |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 CertificateSigningRequest | OK |
list or watch objects of kind CertificateSigningRequest
+GET /apis/certificates.k8s.io/v1beta1/certificatesigningrequests
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 CertificateSigningRequestList | OK |
watch changes to an object of kind CertificateSigningRequest. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/certificates.k8s.io/v1beta1/watch/certificatesigningrequests/{name}
+| Parameter | Description |
|---|---|
name | name of the CertificateSigningRequest |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of CertificateSigningRequest. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/certificates.k8s.io/v1beta1/watch/certificatesigningrequests
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified CertificateSigningRequest
+PATCH /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}/status
+| Parameter | Description |
|---|---|
name | name of the CertificateSigningRequest |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 CertificateSigningRequest | OK |
read status of the specified CertificateSigningRequest
+GET /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}/status
+| Parameter | Description |
|---|---|
name | name of the CertificateSigningRequest |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 CertificateSigningRequest | OK |
replace status of the specified CertificateSigningRequest
+PUT /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}/status
+| Parameter | Description |
|---|---|
name | name of the CertificateSigningRequest |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyCertificateSigningRequest |
| Code | Description |
|---|---|
| 200 CertificateSigningRequest | OK |
| 201 CertificateSigningRequest | Created |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1 | ClusterRole |
| Field | Description |
|---|---|
aggregationRuleAggregationRule | 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. |
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. |
rulesPolicyRule array | Rules holds all the PolicyRules for this ClusterRole |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsClusterRole array | Items is a list of ClusterRoles |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard object's metadata. |
create a ClusterRole
+POST /apis/rbac.authorization.k8s.io/v1/clusterroles
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyClusterRole |
| Code | Description |
|---|---|
| 202 ClusterRole | Accepted |
| 200 ClusterRole | OK |
| 201 ClusterRole | Created |
partially update the specified ClusterRole
+PATCH /apis/rbac.authorization.k8s.io/v1/clusterroles/{name}
+| Parameter | Description |
|---|---|
name | name of the ClusterRole |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ClusterRole | OK |
replace the specified ClusterRole
+PUT /apis/rbac.authorization.k8s.io/v1/clusterroles/{name}
+| Parameter | Description |
|---|---|
name | name of the ClusterRole |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyClusterRole |
| Code | Description |
|---|---|
| 200 ClusterRole | OK |
| 201 ClusterRole | Created |
delete a ClusterRole
+DELETE /apis/rbac.authorization.k8s.io/v1/clusterroles/{name}
+| Parameter | Description |
|---|---|
name | name of the ClusterRole |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of ClusterRole
+DELETE /apis/rbac.authorization.k8s.io/v1/clusterroles
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified ClusterRole
+GET /apis/rbac.authorization.k8s.io/v1/clusterroles/{name}
+| Parameter | Description |
|---|---|
name | name of the ClusterRole |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 ClusterRole | OK |
list or watch objects of kind ClusterRole
+GET /apis/rbac.authorization.k8s.io/v1/clusterroles
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 ClusterRoleList | OK |
watch changes to an object of kind ClusterRole. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/rbac.authorization.k8s.io/v1/watch/clusterroles/{name}
+| Parameter | Description |
|---|---|
name | name of the ClusterRole |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ClusterRole. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/rbac.authorization.k8s.io/v1/watch/clusterroles
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1 | ClusterRoleBinding |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. |
roleRefRoleRef | RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. |
subjectsSubject array | Subjects holds references to the objects the role applies to. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsClusterRoleBinding array | Items is a list of ClusterRoleBindings |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard object's metadata. |
create a ClusterRoleBinding
+POST /apis/rbac.authorization.k8s.io/v1/clusterrolebindings
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyClusterRoleBinding |
| Code | Description |
|---|---|
| 200 ClusterRoleBinding | OK |
| 201 ClusterRoleBinding | Created |
| 202 ClusterRoleBinding | Accepted |
partially update the specified ClusterRoleBinding
+PATCH /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name}
+| Parameter | Description |
|---|---|
name | name of the ClusterRoleBinding |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ClusterRoleBinding | OK |
replace the specified ClusterRoleBinding
+PUT /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name}
+| Parameter | Description |
|---|---|
name | name of the ClusterRoleBinding |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyClusterRoleBinding |
| Code | Description |
|---|---|
| 200 ClusterRoleBinding | OK |
| 201 ClusterRoleBinding | Created |
delete a ClusterRoleBinding
+DELETE /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name}
+| Parameter | Description |
|---|---|
name | name of the ClusterRoleBinding |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of ClusterRoleBinding
+DELETE /apis/rbac.authorization.k8s.io/v1/clusterrolebindings
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified ClusterRoleBinding
+GET /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name}
+| Parameter | Description |
|---|---|
name | name of the ClusterRoleBinding |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 ClusterRoleBinding | OK |
list or watch objects of kind ClusterRoleBinding
+GET /apis/rbac.authorization.k8s.io/v1/clusterrolebindings
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 ClusterRoleBindingList | OK |
watch changes to an object of kind ClusterRoleBinding. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/rbac.authorization.k8s.io/v1/watch/clusterrolebindings/{name}
+| Parameter | Description |
|---|---|
name | name of the ClusterRoleBinding |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ClusterRoleBinding. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/rbac.authorization.k8s.io/v1/watch/clusterrolebindings
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
core | v1 | ComponentStatus |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
conditionsComponentCondition array patch strategy: merge patch merge key: type | List of component conditions observed |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsComponentStatus array | List of ComponentStatus objects. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
read the specified ComponentStatus
+GET /api/v1/componentstatuses/{name}
+| Parameter | Description |
|---|---|
name | name of the ComponentStatus |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 ComponentStatus | OK |
list objects of kind ComponentStatus
+GET /api/v1/componentstatuses
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 ComponentStatusList | OK |
| Group | Version | Kind |
|---|---|---|
authorization.k8s.io | v1 | LocalSubjectAccessReview |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | |
specSubjectAccessReviewSpec | 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. |
statusSubjectAccessReviewStatus | Status is filled in by the server and indicates whether the request is allowed or not |
create a LocalSubjectAccessReview
+POST /apis/authorization.k8s.io/v1/namespaces/{namespace}/localsubjectaccessreviews
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
includeUninitialized | If IncludeUninitialized is specified, the object may be returned without completing initialization. |
pretty | If 'true', then the output is pretty printed. |
| Parameter | Description |
|---|---|
bodyLocalSubjectAccessReview |
| Code | Description |
|---|---|
| 200 LocalSubjectAccessReview | OK |
| 201 LocalSubjectAccessReview | Created |
| 202 LocalSubjectAccessReview | Accepted |
| Group | Version | Kind |
|---|---|---|
core | v1 | Namespace |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
specNamespaceSpec | Spec defines the behavior of the Namespace. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
statusNamespaceStatus | Status describes the current status of a Namespace. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
finalizersstring array | Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/ |
| Field | Description |
|---|---|
phasestring | Phase is the current lifecycle phase of the namespace. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/ |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsNamespace array | Items is the list of Namespace objects in the list. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
create a Namespace
+POST /api/v1/namespaces
+| Parameter | Description |
|---|---|
includeUninitialized | If IncludeUninitialized is specified, the object may be returned without completing initialization. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyNamespace |
| Code | Description |
|---|---|
| 200 Namespace | OK |
| 201 Namespace | Created |
| 202 Namespace | Accepted |
partially update the specified Namespace
+PATCH /api/v1/namespaces/{name}
+| Parameter | Description |
|---|---|
name | name of the Namespace |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Namespace | OK |
replace the specified Namespace
+PUT /api/v1/namespaces/{name}
+| Parameter | Description |
|---|---|
name | name of the Namespace |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyNamespace |
| Code | Description |
|---|---|
| 200 Namespace | OK |
| 201 Namespace | Created |
delete a Namespace
+DELETE /api/v1/namespaces/{name}
+| Parameter | Description |
|---|---|
name | name of the Namespace |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
read the specified Namespace
+GET /api/v1/namespaces/{name}
+| Parameter | Description |
|---|---|
name | name of the Namespace |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 Namespace | OK |
list or watch objects of kind Namespace
+GET /api/v1/namespaces
+| Parameter | Description |
|---|---|
includeUninitialized | If IncludeUninitialized is specified, the object may be returned without completing initialization. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 NamespaceList | OK |
watch changes to an object of kind Namespace. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /api/v1/watch/namespaces/{name}
+| Parameter | Description |
|---|---|
name | name of the Namespace |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Namespace. deprecated: use the 'watch' parameter with a list operation instead.
+GET /api/v1/watch/namespaces
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified Namespace
+PATCH /api/v1/namespaces/{name}/status
+| Parameter | Description |
|---|---|
name | name of the Namespace |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Namespace | OK |
read status of the specified Namespace
+GET /api/v1/namespaces/{name}/status
+| Parameter | Description |
|---|---|
name | name of the Namespace |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Namespace | OK |
replace status of the specified Namespace
+PUT /api/v1/namespaces/{name}/status
+| Parameter | Description |
|---|---|
name | name of the Namespace |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyNamespace |
| Code | Description |
|---|---|
| 200 Namespace | OK |
| 201 Namespace | Created |
| Group | Version | Kind |
|---|---|---|
core | v1 | Node |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
specNodeSpec | Spec defines the behavior of a node. https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
statusNodeStatus | Most recently observed status of the node. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
configSourceNodeConfigSource | If specified, the source to get node configuration from The DynamicKubeletConfig feature gate must be enabled for the Kubelet to use this field |
externalIDstring | Deprecated. Not all kubelets will set this field. Remove field after 1.13. see: https://issues.k8s.io/61966 |
podCIDRstring | PodCIDR represents the pod IP range assigned to the node. |
providerIDstring | ID of the node assigned by the cloud provider in the format: <ProviderName>://<ProviderSpecificNodeID> |
taintsTaint array | If specified, the node's taints. |
unschedulableboolean | Unschedulable controls node schedulability of new pods. By default, node is schedulable. More info: https://kubernetes.io/docs/concepts/nodes/node/#manual-node-administration |
| Field | Description |
|---|---|
addressesNodeAddress array patch strategy: merge patch merge key: type | List of addresses reachable to the node. Queried from cloud provider, if available. More info: https://kubernetes.io/docs/concepts/nodes/node/#addresses |
allocatableobject | Allocatable represents the resources of a node that are available for scheduling. Defaults to Capacity. |
capacityobject | Capacity represents the total resources of a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity |
conditionsNodeCondition array patch strategy: merge patch merge key: type | Conditions is an array of current observed node conditions. More info: https://kubernetes.io/docs/concepts/nodes/node/#condition |
configNodeConfigStatus | Status of the config assigned to the node via the dynamic Kubelet config feature. |
daemonEndpointsNodeDaemonEndpoints | Endpoints of daemons running on the Node. |
imagesContainerImage array | List of container images on this node |
nodeInfoNodeSystemInfo | Set of ids/uuids to uniquely identify the node. More info: https://kubernetes.io/docs/concepts/nodes/node/#info |
phasestring | NodePhase is the recently observed lifecycle phase of the node. More info: https://kubernetes.io/docs/concepts/nodes/node/#phase The field is never populated, and now is deprecated. |
volumesAttachedAttachedVolume array | List of volumes that are attached to the node. |
volumesInUsestring array | List of attachable volumes in use (mounted) by the node. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsNode array | List of nodes |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
create a Node
+POST /api/v1/nodes
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyNode |
| Code | Description |
|---|---|
| 200 Node | OK |
| 201 Node | Created |
| 202 Node | Accepted |
partially update the specified Node
+PATCH /api/v1/nodes/{name}
+| Parameter | Description |
|---|---|
name | name of the Node |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Node | OK |
replace the specified Node
+PUT /api/v1/nodes/{name}
+| Parameter | Description |
|---|---|
name | name of the Node |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyNode |
| Code | Description |
|---|---|
| 200 Node | OK |
| 201 Node | Created |
delete a Node
+DELETE /api/v1/nodes/{name}
+| Parameter | Description |
|---|---|
name | name of the Node |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of Node
+DELETE /api/v1/nodes
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified Node
+GET /api/v1/nodes/{name}
+| Parameter | Description |
|---|---|
name | name of the Node |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 Node | OK |
list or watch objects of kind Node
+GET /api/v1/nodes
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 NodeList | OK |
watch changes to an object of kind Node. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /api/v1/watch/nodes/{name}
+| Parameter | Description |
|---|---|
name | name of the Node |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Node. deprecated: use the 'watch' parameter with a list operation instead.
+GET /api/v1/watch/nodes
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified Node
+PATCH /api/v1/nodes/{name}/status
+| Parameter | Description |
|---|---|
name | name of the Node |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Node | OK |
read status of the specified Node
+GET /api/v1/nodes/{name}/status
+| Parameter | Description |
|---|---|
name | name of the Node |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Node | OK |
replace status of the specified Node
+PUT /api/v1/nodes/{name}/status
+| Parameter | Description |
|---|---|
name | name of the Node |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyNode |
| Code | Description |
|---|---|
| 200 Node | OK |
| 201 Node | Created |
connect POST requests to proxy of Node
+POST /api/v1/nodes/{name}/proxy
+| Parameter | Description |
|---|---|
name | name of the NodeProxyOptions |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to node. |
| Code | Description |
|---|---|
| 200 string | OK |
connect POST requests to proxy of Node
+POST /api/v1/nodes/{name}/proxy/{path}
+| Parameter | Description |
|---|---|
name | name of the NodeProxyOptions |
path | path to the resource |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to node. |
| Code | Description |
|---|---|
| 200 string | OK |
connect DELETE requests to proxy of Node
+DELETE /api/v1/nodes/{name}/proxy
+| Parameter | Description |
|---|---|
name | name of the NodeProxyOptions |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to node. |
| Code | Description |
|---|---|
| 200 string | OK |
connect DELETE requests to proxy of Node
+DELETE /api/v1/nodes/{name}/proxy/{path}
+| Parameter | Description |
|---|---|
name | name of the NodeProxyOptions |
path | path to the resource |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to node. |
| Code | Description |
|---|---|
| 200 string | OK |
connect GET requests to proxy of Node
+GET /api/v1/nodes/{name}/proxy
+| Parameter | Description |
|---|---|
name | name of the NodeProxyOptions |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to node. |
| Code | Description |
|---|---|
| 200 string | OK |
connect GET requests to proxy of Node
+GET /api/v1/nodes/{name}/proxy/{path}
+| Parameter | Description |
|---|---|
name | name of the NodeProxyOptions |
path | path to the resource |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to node. |
| Code | Description |
|---|---|
| 200 string | OK |
connect HEAD requests to proxy of Node
+HEAD /api/v1/nodes/{name}/proxy
+| Parameter | Description |
|---|---|
name | name of the NodeProxyOptions |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to node. |
| Code | Description |
|---|---|
| 200 string | OK |
connect HEAD requests to proxy of Node
+HEAD /api/v1/nodes/{name}/proxy/{path}
+| Parameter | Description |
|---|---|
name | name of the NodeProxyOptions |
path | path to the resource |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to node. |
| Code | Description |
|---|---|
| 200 string | OK |
connect PUT requests to proxy of Node
+PUT /api/v1/nodes/{name}/proxy
+| Parameter | Description |
|---|---|
name | name of the NodeProxyOptions |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to node. |
| Code | Description |
|---|---|
| 200 string | OK |
connect PUT requests to proxy of Node
+PUT /api/v1/nodes/{name}/proxy/{path}
+| Parameter | Description |
|---|---|
name | name of the NodeProxyOptions |
path | path to the resource |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to node. |
| Code | Description |
|---|---|
| 200 string | OK |
| Group | Version | Kind |
|---|---|---|
core | v1 | PersistentVolume |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
specPersistentVolumeSpec | Spec defines a specification of a persistent volume owned by the cluster. Provisioned by an administrator. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumes |
statusPersistentVolumeStatus | Status represents the current information/status for the persistent volume. Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumes |
| Field | Description |
|---|---|
accessModesstring array | AccessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes |
awsElasticBlockStoreAWSElasticBlockStoreVolumeSource | AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
azureDiskAzureDiskVolumeSource | AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. |
azureFileAzureFilePersistentVolumeSource | AzureFile represents an Azure File Service mount on the host and bind mount to the pod. |
capacityobject | A description of the persistent volume's resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity |
cephfsCephFSPersistentVolumeSource | CephFS represents a Ceph FS mount on the host that shares a pod's lifetime |
cinderCinderPersistentVolumeSource | Cinder represents a cinder volume attached and mounted on kubelets host machine More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md |
claimRefObjectReference | ClaimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. Expected to be non-nil when bound. claim.VolumeName is the authoritative bind between PV and PVC. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding |
csiCSIPersistentVolumeSource | CSI represents storage that handled by an external CSI driver (Beta feature). |
fcFCVolumeSource | FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. |
flexVolumeFlexPersistentVolumeSource | FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. |
flockerFlockerVolumeSource | 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 |
gcePersistentDiskGCEPersistentDiskVolumeSource | GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
glusterfsGlusterfsPersistentVolumeSource | Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md |
hostPathHostPathVolumeSource | 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 |
iscsiISCSIPersistentVolumeSource | ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin. |
localLocalVolumeSource | Local represents directly-attached storage with node affinity |
mountOptionsstring array | A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options |
nfsNFSVolumeSource | NFS represents an NFS mount on the host. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
nodeAffinityVolumeNodeAffinity | NodeAffinity defines constraints that limit what nodes this volume can be accessed from. This field influences the scheduling of pods that use this volume. |
persistentVolumeReclaimPolicystring | 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 |
photonPersistentDiskPhotonPersistentDiskVolumeSource | PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine |
portworxVolumePortworxVolumeSource | PortworxVolume represents a portworx volume attached and mounted on kubelets host machine |
quobyteQuobyteVolumeSource | Quobyte represents a Quobyte mount on the host that shares a pod's lifetime |
rbdRBDPersistentVolumeSource | RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md |
scaleIOScaleIOPersistentVolumeSource | ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. |
storageClassNamestring | Name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass. |
storageosStorageOSPersistentVolumeSource | StorageOS represents a StorageOS volume that is attached to the kubelet's host machine and mounted into the pod More info: https://releases.k8s.io/HEAD/examples/volumes/storageos/README.md |
volumeModestring | 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 a beta feature. |
vsphereVolumeVsphereVirtualDiskVolumeSource | VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine |
| Field | Description |
|---|---|
messagestring | A human-readable message indicating details about why the volume is in this state. |
phasestring | Phase indicates if a volume is available, bound to a claim, or released by a claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#phase |
reasonstring | Reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsPersistentVolume array | List of persistent volumes. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
create a PersistentVolume
+POST /api/v1/persistentvolumes
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPersistentVolume |
| Code | Description |
|---|---|
| 202 PersistentVolume | Accepted |
| 200 PersistentVolume | OK |
| 201 PersistentVolume | Created |
partially update the specified PersistentVolume
+PATCH /api/v1/persistentvolumes/{name}
+| Parameter | Description |
|---|---|
name | name of the PersistentVolume |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 PersistentVolume | OK |
replace the specified PersistentVolume
+PUT /api/v1/persistentvolumes/{name}
+| Parameter | Description |
|---|---|
name | name of the PersistentVolume |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPersistentVolume |
| Code | Description |
|---|---|
| 200 PersistentVolume | OK |
| 201 PersistentVolume | Created |
delete a PersistentVolume
+DELETE /api/v1/persistentvolumes/{name}
+| Parameter | Description |
|---|---|
name | name of the PersistentVolume |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of PersistentVolume
+DELETE /api/v1/persistentvolumes
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified PersistentVolume
+GET /api/v1/persistentvolumes/{name}
+| Parameter | Description |
|---|---|
name | name of the PersistentVolume |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 PersistentVolume | OK |
list or watch objects of kind PersistentVolume
+GET /api/v1/persistentvolumes
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 PersistentVolumeList | OK |
watch changes to an object of kind PersistentVolume. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /api/v1/watch/persistentvolumes/{name}
+| Parameter | Description |
|---|---|
name | name of the PersistentVolume |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of PersistentVolume. deprecated: use the 'watch' parameter with a list operation instead.
+GET /api/v1/watch/persistentvolumes
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified PersistentVolume
+PATCH /api/v1/persistentvolumes/{name}/status
+| Parameter | Description |
|---|---|
name | name of the PersistentVolume |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 PersistentVolume | OK |
read status of the specified PersistentVolume
+GET /api/v1/persistentvolumes/{name}/status
+| Parameter | Description |
|---|---|
name | name of the PersistentVolume |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 PersistentVolume | OK |
replace status of the specified PersistentVolume
+PUT /api/v1/persistentvolumes/{name}/status
+| Parameter | Description |
|---|---|
name | name of the PersistentVolume |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPersistentVolume |
| Code | Description |
|---|---|
| 200 PersistentVolume | OK |
| 201 PersistentVolume | Created |
| Group | Version | Kind |
|---|---|---|
core | v1 | ResourceQuota |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
specResourceQuotaSpec | Spec defines the desired quota. https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
statusResourceQuotaStatus | Status defines the actual enforced quota and its current usage. https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
hardobject | hard is the set of desired hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ |
scopeSelectorScopeSelector | scopeSelector is also a collection of filters like scopes that must match each object tracked by a quota but expressed using ScopeSelectorOperator in combination with possible values. For a resource to match, both scopes AND scopeSelector (if specified in spec), must be matched. |
scopesstring array | A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects. |
| Field | Description |
|---|---|
hardobject | Hard is the set of enforced hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ |
usedobject | Used is the current observed total usage of the resource in the namespace. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsResourceQuota array | Items is a list of ResourceQuota objects. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
create a ResourceQuota
+POST /api/v1/namespaces/{namespace}/resourcequotas
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyResourceQuota |
| Code | Description |
|---|---|
| 202 ResourceQuota | Accepted |
| 200 ResourceQuota | OK |
| 201 ResourceQuota | Created |
partially update the specified ResourceQuota
+PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}
+| Parameter | Description |
|---|---|
name | name of the ResourceQuota |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ResourceQuota | OK |
replace the specified ResourceQuota
+PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}
+| Parameter | Description |
|---|---|
name | name of the ResourceQuota |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyResourceQuota |
| Code | Description |
|---|---|
| 200 ResourceQuota | OK |
| 201 ResourceQuota | Created |
delete a ResourceQuota
+DELETE /api/v1/namespaces/{namespace}/resourcequotas/{name}
+| Parameter | Description |
|---|---|
name | name of the ResourceQuota |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of ResourceQuota
+DELETE /api/v1/namespaces/{namespace}/resourcequotas
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified ResourceQuota
+GET /api/v1/namespaces/{namespace}/resourcequotas/{name}
+| Parameter | Description |
|---|---|
name | name of the ResourceQuota |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 ResourceQuota | OK |
list or watch objects of kind ResourceQuota
+GET /api/v1/namespaces/{namespace}/resourcequotas
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 ResourceQuotaList | OK |
list or watch objects of kind ResourceQuota
+GET /api/v1/resourcequotas
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 ResourceQuotaList | OK |
watch changes to an object of kind ResourceQuota. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /api/v1/watch/namespaces/{namespace}/resourcequotas/{name}
+| Parameter | Description |
|---|---|
name | name of the ResourceQuota |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ResourceQuota. deprecated: use the 'watch' parameter with a list operation instead.
+GET /api/v1/watch/namespaces/{namespace}/resourcequotas
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ResourceQuota. deprecated: use the 'watch' parameter with a list operation instead.
+GET /api/v1/watch/resourcequotas
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified ResourceQuota
+PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
+| Parameter | Description |
|---|---|
name | name of the ResourceQuota |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ResourceQuota | OK |
read status of the specified ResourceQuota
+GET /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
+| Parameter | Description |
|---|---|
name | name of the ResourceQuota |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 ResourceQuota | OK |
replace status of the specified ResourceQuota
+PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
+| Parameter | Description |
|---|---|
name | name of the ResourceQuota |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyResourceQuota |
| Code | Description |
|---|---|
| 200 ResourceQuota | OK |
| 201 ResourceQuota | Created |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1 | Role |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. |
rulesPolicyRule array | Rules holds all the PolicyRules for this Role |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsRole array | Items is a list of Roles |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard object's metadata. |
create a Role
+POST /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyRole |
| Code | Description |
|---|---|
| 200 Role | OK |
| 201 Role | Created |
| 202 Role | Accepted |
partially update the specified Role
+PATCH /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name}
+| Parameter | Description |
|---|---|
name | name of the Role |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Role | OK |
replace the specified Role
+PUT /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name}
+| Parameter | Description |
|---|---|
name | name of the Role |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyRole |
| Code | Description |
|---|---|
| 200 Role | OK |
| 201 Role | Created |
delete a Role
+DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name}
+| Parameter | Description |
|---|---|
name | name of the Role |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of Role
+DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified Role
+GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name}
+| Parameter | Description |
|---|---|
name | name of the Role |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Role | OK |
list or watch objects of kind Role
+GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 RoleList | OK |
list or watch objects of kind Role
+GET /apis/rbac.authorization.k8s.io/v1/roles
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 RoleList | OK |
watch changes to an object of kind Role. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/roles/{name}
+| Parameter | Description |
|---|---|
name | name of the Role |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Role. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/roles
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Role. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/rbac.authorization.k8s.io/v1/watch/roles
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1 | RoleBinding |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. |
roleRefRoleRef | 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. |
subjectsSubject array | Subjects holds references to the objects the role applies to. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsRoleBinding array | Items is a list of RoleBindings |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard object's metadata. |
create a RoleBinding
+POST /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyRoleBinding |
| Code | Description |
|---|---|
| 200 RoleBinding | OK |
| 201 RoleBinding | Created |
| 202 RoleBinding | Accepted |
partially update the specified RoleBinding
+PATCH /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name}
+| Parameter | Description |
|---|---|
name | name of the RoleBinding |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 RoleBinding | OK |
replace the specified RoleBinding
+PUT /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name}
+| Parameter | Description |
|---|---|
name | name of the RoleBinding |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyRoleBinding |
| Code | Description |
|---|---|
| 200 RoleBinding | OK |
| 201 RoleBinding | Created |
delete a RoleBinding
+DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name}
+| Parameter | Description |
|---|---|
name | name of the RoleBinding |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of RoleBinding
+DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified RoleBinding
+GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name}
+| Parameter | Description |
|---|---|
name | name of the RoleBinding |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 RoleBinding | OK |
list or watch objects of kind RoleBinding
+GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 RoleBindingList | OK |
list or watch objects of kind RoleBinding
+GET /apis/rbac.authorization.k8s.io/v1/rolebindings
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 RoleBindingList | OK |
watch changes to an object of kind RoleBinding. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/rolebindings/{name}
+| Parameter | Description |
|---|---|
name | name of the RoleBinding |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of RoleBinding. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/rolebindings
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of RoleBinding. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/rbac.authorization.k8s.io/v1/watch/rolebindings
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
authorization.k8s.io | v1 | SelfSubjectAccessReview |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | |
specSelfSubjectAccessReviewSpec | Spec holds information about the request being evaluated. user and groups must be empty |
statusSubjectAccessReviewStatus | Status is filled in by the server and indicates whether the request is allowed or not |
| Field | Description |
|---|---|
nonResourceAttributesNonResourceAttributes | NonResourceAttributes describes information for a non-resource access request |
resourceAttributesResourceAttributes | ResourceAuthorizationAttributes describes information for a resource access request |
create a SelfSubjectAccessReview
+POST /apis/authorization.k8s.io/v1/selfsubjectaccessreviews
+| Parameter | Description |
|---|---|
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
includeUninitialized | If IncludeUninitialized is specified, the object may be returned without completing initialization. |
pretty | If 'true', then the output is pretty printed. |
| Parameter | Description |
|---|---|
bodySelfSubjectAccessReview |
| Code | Description |
|---|---|
| 202 SelfSubjectAccessReview | Accepted |
| 200 SelfSubjectAccessReview | OK |
| 201 SelfSubjectAccessReview | Created |
| Group | Version | Kind |
|---|---|---|
authorization.k8s.io | v1 | SelfSubjectRulesReview |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | |
specSelfSubjectRulesReviewSpec | Spec holds information about the request being evaluated. |
statusSubjectRulesReviewStatus | Status is filled in by the server and indicates the set of actions a user can perform. |
| Field | Description |
|---|---|
namespacestring | Namespace to evaluate rules for. Required. |
create a SelfSubjectRulesReview
+POST /apis/authorization.k8s.io/v1/selfsubjectrulesreviews
+| Parameter | Description |
|---|---|
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
includeUninitialized | If IncludeUninitialized is specified, the object may be returned without completing initialization. |
pretty | If 'true', then the output is pretty printed. |
| Parameter | Description |
|---|---|
bodySelfSubjectRulesReview |
| Code | Description |
|---|---|
| 200 SelfSubjectRulesReview | OK |
| 201 SelfSubjectRulesReview | Created |
| 202 SelfSubjectRulesReview | Accepted |
| Group | Version | Kind |
|---|---|---|
core | v1 | ServiceAccount |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
automountServiceAccountTokenboolean | AutomountServiceAccountToken indicates whether pods running as this service account should have an API token automatically mounted. Can be overridden at the pod level. |
imagePullSecretsLocalObjectReference array | 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 |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
secretsObjectReference array patch strategy: merge patch merge key: name | Secrets is the list of secrets allowed to be used by pods running using this ServiceAccount. More info: https://kubernetes.io/docs/concepts/configuration/secret |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsServiceAccount array | List of ServiceAccounts. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
create a ServiceAccount
+POST /api/v1/namespaces/{namespace}/serviceaccounts
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyServiceAccount |
| Code | Description |
|---|---|
| 201 ServiceAccount | Created |
| 202 ServiceAccount | Accepted |
| 200 ServiceAccount | OK |
partially update the specified ServiceAccount
+PATCH /api/v1/namespaces/{namespace}/serviceaccounts/{name}
+| Parameter | Description |
|---|---|
name | name of the ServiceAccount |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ServiceAccount | OK |
replace the specified ServiceAccount
+PUT /api/v1/namespaces/{namespace}/serviceaccounts/{name}
+| Parameter | Description |
|---|---|
name | name of the ServiceAccount |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyServiceAccount |
| Code | Description |
|---|---|
| 200 ServiceAccount | OK |
| 201 ServiceAccount | Created |
delete a ServiceAccount
+DELETE /api/v1/namespaces/{namespace}/serviceaccounts/{name}
+| Parameter | Description |
|---|---|
name | name of the ServiceAccount |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of ServiceAccount
+DELETE /api/v1/namespaces/{namespace}/serviceaccounts
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified ServiceAccount
+GET /api/v1/namespaces/{namespace}/serviceaccounts/{name}
+| Parameter | Description |
|---|---|
name | name of the ServiceAccount |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 ServiceAccount | OK |
list or watch objects of kind ServiceAccount
+GET /api/v1/namespaces/{namespace}/serviceaccounts
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 ServiceAccountList | OK |
list or watch objects of kind ServiceAccount
+GET /api/v1/serviceaccounts
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 ServiceAccountList | OK |
watch changes to an object of kind ServiceAccount. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /api/v1/watch/namespaces/{namespace}/serviceaccounts/{name}
+| Parameter | Description |
|---|---|
name | name of the ServiceAccount |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ServiceAccount. deprecated: use the 'watch' parameter with a list operation instead.
+GET /api/v1/watch/namespaces/{namespace}/serviceaccounts
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ServiceAccount. deprecated: use the 'watch' parameter with a list operation instead.
+GET /api/v1/watch/serviceaccounts
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
authorization.k8s.io | v1 | SubjectAccessReview |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | |
specSubjectAccessReviewSpec | Spec holds information about the request being evaluated |
statusSubjectAccessReviewStatus | Status is filled in by the server and indicates whether the request is allowed or not |
| Field | Description |
|---|---|
extraobject | Extra corresponds to the user.Info.GetExtra() method from the authenticator. Since that is input to the authorizer it needs a reflection here. |
groupsstring array | Groups is the groups you're testing for. |
nonResourceAttributesNonResourceAttributes | NonResourceAttributes describes information for a non-resource access request |
resourceAttributesResourceAttributes | ResourceAuthorizationAttributes describes information for a resource access request |
uidstring | UID information about the requesting user. |
userstring | 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 |
| Field | Description |
|---|---|
allowedboolean | Allowed is required. True if the action would be allowed, false otherwise. |
deniedboolean | 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. |
evaluationErrorstring | 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. |
reasonstring | Reason is optional. It indicates why a request was allowed or denied. |
create a SubjectAccessReview
+POST /apis/authorization.k8s.io/v1/subjectaccessreviews
+| Parameter | Description |
|---|---|
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
includeUninitialized | If IncludeUninitialized is specified, the object may be returned without completing initialization. |
pretty | If 'true', then the output is pretty printed. |
| Parameter | Description |
|---|---|
bodySubjectAccessReview |
| Code | Description |
|---|---|
| 200 SubjectAccessReview | OK |
| 201 SubjectAccessReview | Created |
| 202 SubjectAccessReview | Accepted |
| Group | Version | Kind |
|---|---|---|
authentication.k8s.io | v1 | TokenReview |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | |
specTokenReviewSpec | Spec holds information about the request being evaluated |
statusTokenReviewStatus | Status is filled in by the server and indicates whether the request can be authenticated. |
| Field | Description |
|---|---|
audiencesstring array | Audiences is a list of the identifiers that the resource server presented with the token identifies as. Audience-aware token authenticators will verify that the token was intended for at least one of the audiences in this list. If no audiences are provided, the audience will default to the audience of the Kubernetes apiserver. |
tokenstring | Token is the opaque bearer token. |
| Field | Description |
|---|---|
audiencesstring array | Audiences are audience identifiers chosen by the authenticator that are compatible with both the TokenReview and token. An identifier is any identifier in the intersection of the TokenReviewSpec audiences and the token's audiences. A client of the TokenReview API that sets the spec.audiences field should validate that a compatible audience identifier is returned in the status.audiences field to ensure that the TokenReview server is audience aware. If a TokenReview returns an empty status.audience field where status.authenticated is "true", the token is valid against the audience of the Kubernetes API server. |
authenticatedboolean | Authenticated indicates that the token was associated with a known user. |
errorstring | Error indicates that the token couldn't be checked |
userUserInfo | User is the UserInfo associated with the provided token. |
create a TokenReview
+POST /apis/authentication.k8s.io/v1/tokenreviews
+| Parameter | Description |
|---|---|
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
includeUninitialized | If IncludeUninitialized is specified, the object may be returned without completing initialization. |
pretty | If 'true', then the output is pretty printed. |
| Parameter | Description |
|---|---|
bodyTokenReview |
| Code | Description |
|---|---|
| 200 TokenReview | OK |
| 201 TokenReview | Created |
| 202 TokenReview | Accepted |
| Group | Version | Kind |
|---|---|---|
networking.k8s.io | v1 | NetworkPolicy |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
specNetworkPolicySpec | Specification of the desired behavior for this NetworkPolicy. |
| Field | Description |
|---|---|
egressNetworkPolicyEgressRule array | 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 |
ingressNetworkPolicyIngressRule array | 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) |
podSelectorLabelSelector | 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. |
policyTypesstring 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 |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsNetworkPolicy array | Items is a list of schema objects. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
create a NetworkPolicy
+POST /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyNetworkPolicy |
| Code | Description |
|---|---|
| 202 NetworkPolicy | Accepted |
| 200 NetworkPolicy | OK |
| 201 NetworkPolicy | Created |
partially update the specified NetworkPolicy
+PATCH /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}
+| Parameter | Description |
|---|---|
name | name of the NetworkPolicy |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 NetworkPolicy | OK |
replace the specified NetworkPolicy
+PUT /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}
+| Parameter | Description |
|---|---|
name | name of the NetworkPolicy |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyNetworkPolicy |
| Code | Description |
|---|---|
| 200 NetworkPolicy | OK |
| 201 NetworkPolicy | Created |
delete a NetworkPolicy
+DELETE /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}
+| Parameter | Description |
|---|---|
name | name of the NetworkPolicy |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of NetworkPolicy
+DELETE /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified NetworkPolicy
+GET /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}
+| Parameter | Description |
|---|---|
name | name of the NetworkPolicy |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 NetworkPolicy | OK |
list or watch objects of kind NetworkPolicy
+GET /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 NetworkPolicyList | OK |
list or watch objects of kind NetworkPolicy
+GET /apis/networking.k8s.io/v1/networkpolicies
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 NetworkPolicyList | OK |
watch changes to an object of kind NetworkPolicy. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/networking.k8s.io/v1/watch/namespaces/{namespace}/networkpolicies/{name}
+| Parameter | Description |
|---|---|
name | name of the NetworkPolicy |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of NetworkPolicy. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/networking.k8s.io/v1/watch/namespaces/{namespace}/networkpolicies
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of NetworkPolicy. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/networking.k8s.io/v1/watch/networkpolicies
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
This section contains definitions for objects used in the Kubernetes APIs.
+| Group | Version | Kind |
|---|---|---|
meta | v1 | APIGroup |
APIGroup contains the name, the supported versions, and the preferred version of a group.
+| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
namestring | name is the name of the group. |
preferredVersionGroupVersionForDiscovery | preferredVersion is the version preferred by the API server, which probably is the storage version. |
serverAddressByClientCIDRsServerAddressByClientCIDR array | 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. |
versionsGroupVersionForDiscovery array | versions are the versions supported in this group. |
| Group | Version | Kind |
|---|---|---|
meta | v1 | APIResource |
APIResource specifies the name of a resource and whether it is namespaced.
+| Field | Description |
|---|---|
categoriesstring array | categories is a list of the grouped resources this resource belongs to (e.g. 'all') |
groupstring | 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". |
kindstring | kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo') |
namestring | name is the plural name of the resource. |
namespacedboolean | namespaced indicates if a resource is namespaced or not. |
shortNamesstring array | shortNames is a list of suggested short names of the resource. |
singularNamestring | 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. |
verbsstring array | verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy) |
versionstring | 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)". |
| Group | Version | Kind |
|---|---|---|
apiregistration.k8s.io | v1 | APIServiceCondition |
| Field | Description |
|---|---|
lastTransitionTimeTime | Last time the condition transitioned from one status to another. |
messagestring | Human-readable message indicating details about last transition. |
reasonstring | Unique, one-word, CamelCase reason for the condition's last transition. |
statusstring | Status is the status of the condition. Can be True, False, Unknown. |
typestring | Type is the type of the condition. |
| Group | Version | Kind |
|---|---|---|
meta | v1 | APIVersions |
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.
+| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
serverAddressByClientCIDRsServerAddressByClientCIDR array | 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. |
versionsstring array | versions are the api versions that are available. |
| Group | Version | Kind |
|---|---|---|
core | v1 | AWSElasticBlockStoreVolumeSource |
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.
+| Field | Description |
|---|---|
fsTypestring | 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 |
partitioninteger | 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). |
readOnlyboolean | Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
volumeIDstring | Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
| Group | Version | Kind |
|---|---|---|
core | v1 | Affinity |
Affinity is a group of affinity scheduling rules.
+| Field | Description |
|---|---|
nodeAffinityNodeAffinity | Describes node affinity scheduling rules for the pod. |
podAffinityPodAffinity | Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). |
podAntiAffinityPodAntiAffinity | Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1 | AggregationRule |
AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole
+ +| Field | Description |
|---|---|
clusterRoleSelectorsLabelSelector array | 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 |
| Group | Version | Kind |
|---|---|---|
extensions | v1beta1 | AllowedFlexVolume |
AllowedFlexVolume represents a single Flexvolume that is allowed to be used. Deprecated: use AllowedFlexVolume from policy API Group instead.
+| Field | Description |
|---|---|
driverstring | driver is the name of the Flexvolume driver. |
| Group | Version | Kind |
|---|---|---|
extensions | v1beta1 | AllowedHostPath |
AllowedHostPath defines the host volume conditions that will be enabled by a policy for pods to use. It requires the path prefix to be defined. Deprecated: use AllowedHostPath from policy API Group instead.
+| Field | Description |
|---|---|
pathPrefixstring | pathPrefix 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` |
readOnlyboolean | when set to true, will allow host volumes matching the pathPrefix only if all volume mounts are readOnly. |
| Group | Version | Kind |
|---|---|---|
core | v1 | AttachedVolume |
AttachedVolume describes a volume attached to a node
+| Field | Description |
|---|---|
devicePathstring | DevicePath represents the device path where the volume should be available |
namestring | Name of the attached volume |
| Group | Version | Kind |
|---|---|---|
auditregistration.k8s.io | v1alpha1 | AuditSink |
AuditSink represents a cluster level audit sink
+| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | |
specAuditSinkSpec | Spec defines the audit configuration spec |
| Group | Version | Kind |
|---|---|---|
core | v1 | AzureDiskVolumeSource |
AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
+| Field | Description |
|---|---|
cachingModestring | Host Caching mode: None, Read Only, Read Write. |
diskNamestring | The Name of the data disk in the blob storage |
diskURIstring | The URI the data disk in the blob storage |
fsTypestring | 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. |
kindstring | 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 |
readOnlyboolean | Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
| Group | Version | Kind |
|---|---|---|
core | v1 | AzureFilePersistentVolumeSource |
AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
+| Field | Description |
|---|---|
readOnlyboolean | Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
secretNamestring | the name of secret that contains Azure Storage Account Name and Key |
secretNamespacestring | the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod |
shareNamestring | Share Name |
| Group | Version | Kind |
|---|---|---|
core | v1 | AzureFileVolumeSource |
AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
+| Field | Description |
|---|---|
readOnlyboolean | Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
secretNamestring | the name of secret that contains Azure Storage Account Name and Key |
shareNamestring | Share Name |
| Group | Version | Kind |
|---|---|---|
core | v1 | CSIPersistentVolumeSource |
Represents storage that is managed by an external CSI volume driver (Beta feature)
+| Field | Description |
|---|---|
controllerPublishSecretRefSecretReference | 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. |
driverstring | Driver is the name of the driver to use for this volume. Required. |
fsTypestring | Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". |
nodePublishSecretRefSecretReference | 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. |
nodeStageSecretRefSecretReference | 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. |
readOnlyboolean | Optional: The value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write). |
volumeAttributesobject | Attributes of the volume to publish. |
volumeHandlestring | VolumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required. |
| Group | Version | Kind |
|---|---|---|
core | v1 | Capabilities |
Adds and removes POSIX capabilities from running containers.
+| Field | Description |
|---|---|
addstring array | Added capabilities |
dropstring array | Removed capabilities |
| Group | Version | Kind |
|---|---|---|
core | v1 | CephFSPersistentVolumeSource |
Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.
+| Field | Description |
|---|---|
monitorsstring array | Required: Monitors is a collection of Ceph monitors More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it |
pathstring | Optional: Used as the mounted root, rather than the full Ceph tree, default is / |
readOnlyboolean | Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it |
secretFilestring | Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it |
secretRefSecretReference | Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it |
userstring | Optional: User is the rados user name, default is admin More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it |
| Group | Version | Kind |
|---|---|---|
core | v1 | CephFSVolumeSource |
Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.
+| Field | Description |
|---|---|
monitorsstring array | Required: Monitors is a collection of Ceph monitors More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it |
pathstring | Optional: Used as the mounted root, rather than the full Ceph tree, default is / |
readOnlyboolean | Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it |
secretFilestring | Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it |
secretRefLocalObjectReference | Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it |
userstring | Optional: User is the rados user name, default is admin More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it |
| Group | Version | Kind |
|---|---|---|
certificates.k8s.io | v1beta1 | CertificateSigningRequestCondition |
| Field | Description |
|---|---|
lastUpdateTimeTime | timestamp for the last update to this condition |
messagestring | human readable message with details about the request state |
reasonstring | brief reason for the request state |
typestring | request approval state, currently Approved or Denied. |
| Group | Version | Kind |
|---|---|---|
core | v1 | CinderPersistentVolumeSource |
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.
+| Field | Description |
|---|---|
fsTypestring | Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md |
readOnlyboolean | Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md |
secretRefSecretReference | Optional: points to a secret object containing parameters used to connect to OpenStack. |
volumeIDstring | volume id used to identify the volume in cinder More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md |
| Group | Version | Kind |
|---|---|---|
core | v1 | CinderVolumeSource |
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.
+| Field | Description |
|---|---|
fsTypestring | Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md |
readOnlyboolean | Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md |
secretRefLocalObjectReference | Optional: points to a secret object containing parameters used to connect to OpenStack. |
volumeIDstring | volume id used to identify the volume in cinder More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md |
| Group | Version | Kind |
|---|---|---|
core | v1 | ClientIPConfig |
ClientIPConfig represents the configurations of Client IP based session affinity.
+| Field | Description |
|---|---|
timeoutSecondsinteger | 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). |
| Group | Version | Kind |
|---|---|---|
core | v1 | ComponentCondition |
Information about the condition of a component.
+| Field | Description |
|---|---|
errorstring | Condition error code for a component. For example, a health check error code. |
messagestring | Message about the condition for a component. For example, information about a health check. |
statusstring | Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown". |
typestring | Type of condition for a component. Valid value: "Healthy" |
| Group | Version | Kind |
|---|---|---|
core | v1 | ConfigMapEnvSource |
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.
+| Field | Description |
|---|---|
namestring | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optionalboolean | Specify whether the ConfigMap must be defined |
| Group | Version | Kind |
|---|---|---|
core | v1 | ConfigMapKeySelector |
Selects a key from a ConfigMap.
+| Field | Description |
|---|---|
keystring | The key to select. |
namestring | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optionalboolean | Specify whether the ConfigMap or it's key must be defined |
| Group | Version | Kind |
|---|---|---|
core | v1 | ConfigMapNodeConfigSource |
ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node.
+| Field | Description |
|---|---|
kubeletConfigKeystring | KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases. |
namestring | Name is the metadata.name of the referenced ConfigMap. This field is required in all cases. |
namespacestring | Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases. |
resourceVersionstring | ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. |
uidstring | UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. |
| Group | Version | Kind |
|---|---|---|
core | v1 | ConfigMapProjection |
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.
+| Field | Description |
|---|---|
itemsKeyToPath array | 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 '..'. |
namestring | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optionalboolean | Specify whether the ConfigMap or it's keys must be defined |
| Group | Version | Kind |
|---|---|---|
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.
+| Field | Description |
|---|---|
defaultModeinteger | 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. |
itemsKeyToPath array | 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 '..'. |
namestring | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optionalboolean | Specify whether the ConfigMap or it's keys must be defined |
| Group | Version | Kind |
|---|---|---|
core | v1 | ContainerImage |
Describe a container image
+| Field | Description |
|---|---|
namesstring array | Names by which this image is known. e.g. ["k8s.gcr.io/hyperkube:v1.0.7", "dockerhub.io/google_containers/hyperkube:v1.0.7"] |
sizeBytesinteger | The size of the image in bytes. |
| Group | Version | Kind |
|---|---|---|
core | v1 | ContainerPort |
ContainerPort represents a network port in a single container.
+| Field | Description |
|---|---|
containerPortinteger | Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. |
hostIPstring | What host IP to bind the external port to. |
hostPortinteger | 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. |
namestring | 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. |
protocolstring | Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". |
| Group | Version | Kind |
|---|---|---|
core | v1 | ContainerState |
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.
+| Field | Description |
|---|---|
runningContainerStateRunning | Details about a running container |
terminatedContainerStateTerminated | Details about a terminated container |
waitingContainerStateWaiting | Details about a waiting container |
| Group | Version | Kind |
|---|---|---|
core | v1 | ContainerStateRunning |
ContainerStateRunning is a running state of a container.
+| Field | Description |
|---|---|
startedAtTime | Time at which the container was last (re-)started |
| Group | Version | Kind |
|---|---|---|
core | v1 | ContainerStateTerminated |
ContainerStateTerminated is a terminated state of a container.
+| Field | Description |
|---|---|
containerIDstring | Container's ID in the format 'docker://<container_id>' |
exitCodeinteger | Exit status from the last termination of the container |
finishedAtTime | Time at which the container last terminated |
messagestring | Message regarding the last termination of the container |
reasonstring | (brief) reason from the last termination of the container |
signalinteger | Signal from the last termination of the container |
startedAtTime | Time at which previous execution of the container started |
| Group | Version | Kind |
|---|---|---|
core | v1 | ContainerStateWaiting |
ContainerStateWaiting is a waiting state of a container.
+| Field | Description |
|---|---|
messagestring | Message regarding why the container is not yet running. |
reasonstring | (brief) reason the container is not yet running. |
| Group | Version | Kind |
|---|---|---|
autoscaling | v1 | CrossVersionObjectReference |
CrossVersionObjectReference contains enough information to let you identify the referred resource.
+ +| Field | Description |
|---|---|
apiVersionstring | API version of the referent |
kindstring | Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds" |
namestring | Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| Group | Version | Kind |
|---|---|---|
apiextensions.k8s.io | v1beta1 | CustomResourceColumnDefinition |
CustomResourceColumnDefinition specifies a column for server side printing.
+| Field | Description |
|---|---|
JSONPathstring | JSONPath is a simple JSON path, i.e. with array notation. |
descriptionstring | description is a human readable description of this column. |
formatstring | format is an optional OpenAPI type definition for this column. The 'name' format is applied to the primary identifier column to assist in clients identifying column is the resource name. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for more. |
namestring | name is a human readable name for the column. |
priorityinteger | priority is an integer defining the relative importance of this column compared to others. Lower numbers are considered higher priority. Columns that may be omitted in limited space scenarios should be given a higher priority. |
typestring | type is an OpenAPI type definition for this column. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for more. |
| Group | Version | Kind |
|---|---|---|
apiextensions.k8s.io | v1beta1 | CustomResourceConversion |
CustomResourceConversion describes how to convert different versions of a CR.
+| Field | Description |
|---|---|
strategystring | `strategy` specifies the conversion strategy. Allowed values are: - `None`: The converter only change the apiVersion and would not touch any other field in the CR. - `Webhook`: API Server will call to an external webhook to do the conversion. Additional information is needed for this option. |
webhookClientConfigWebhookClientConfig | `webhookClientConfig` is the instructions for how to call the webhook if strategy is `Webhook`. This field is alpha-level and is only honored by servers that enable the CustomResourceWebhookConversion feature. |
| Group | Version | Kind |
|---|---|---|
apiextensions.k8s.io | v1beta1 | CustomResourceDefinitionCondition |
CustomResourceDefinitionCondition contains details for the current condition of this pod.
+| Field | Description |
|---|---|
lastTransitionTimeTime | Last time the condition transitioned from one status to another. |
messagestring | Human-readable message indicating details about last transition. |
reasonstring | Unique, one-word, CamelCase reason for the condition's last transition. |
statusstring | Status is the status of the condition. Can be True, False, Unknown. |
typestring | Type is the type of the condition. |
| Group | Version | Kind |
|---|---|---|
apiextensions.k8s.io | v1beta1 | CustomResourceDefinitionNames |
CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition
+| Field | Description |
|---|---|
categoriesstring array | Categories is a list of grouped resources custom resources belong to (e.g. 'all') |
kindstring | Kind is the serialized kind of the resource. It is normally CamelCase and singular. |
listKindstring | ListKind is the serialized kind of the list for this resource. Defaults to <kind>List. |
pluralstring | 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. |
shortNamesstring array | ShortNames are short names for the resource. It must be all lowercase. |
singularstring | Singular is the singular name of the resource. It must be all lowercase Defaults to lowercased <kind> |
| Group | Version | Kind |
|---|---|---|
apiextensions.k8s.io | v1beta1 | CustomResourceDefinitionVersion |
CustomResourceDefinitionVersion describes a version for CRD.
+| Field | Description |
|---|---|
additionalPrinterColumnsCustomResourceColumnDefinition array | AdditionalPrinterColumns are additional columns shown e.g. in kubectl next to the name. Defaults to a created-at column. Top-level and per-version columns are mutually exclusive. Per-version columns must not all be set to identical values (top-level columns should be used instead) This field is alpha-level and is only honored by servers that enable the CustomResourceWebhookConversion feature. NOTE: CRDs created prior to 1.13 populated the top-level additionalPrinterColumns field by default. To apply an update that changes to per-version additionalPrinterColumns, the top-level additionalPrinterColumns field must be explicitly set to null |
namestring | Name is the version name, e.g. “v1”, “v2beta1”, etc. |
schemaCustomResourceValidation | Schema describes the schema for CustomResource used in validation, pruning, and defaulting. Top-level and per-version schemas are mutually exclusive. Per-version schemas must not all be set to identical values (top-level validation schema should be used instead) This field is alpha-level and is only honored by servers that enable the CustomResourceWebhookConversion feature. |
servedboolean | Served is a flag enabling/disabling this version from being served via REST APIs |
storageboolean | Storage flags the version as storage version. There must be exactly one flagged as storage version. |
subresourcesCustomResourceSubresources | Subresources describes the subresources for CustomResource Top-level and per-version subresources are mutually exclusive. Per-version subresources must not all be set to identical values (top-level subresources should be used instead) This field is alpha-level and is only honored by servers that enable the CustomResourceWebhookConversion feature. |
| Group | Version | Kind |
|---|---|---|
apiextensions.k8s.io | v1beta1 | CustomResourceSubresourceScale |
CustomResourceSubresourceScale defines how to serve the scale subresource for CustomResources.
+| Field | Description |
|---|---|
labelSelectorPathstring | 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. |
specReplicasPathstring | 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. |
statusReplicasPathstring | 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. |
| Group | Version | Kind |
|---|---|---|
apiextensions.k8s.io | v1beta1 | CustomResourceSubresourceStatus |
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
+| Field | Description |
|---|
| Group | Version | Kind |
|---|---|---|
apiextensions.k8s.io | v1beta1 | CustomResourceSubresources |
CustomResourceSubresources defines the status and scale subresources for CustomResources.
+| Field | Description |
|---|---|
scaleCustomResourceSubresourceScale | Scale denotes the scale subresource for CustomResources |
statusCustomResourceSubresourceStatus | Status denotes the status subresource for CustomResources |
| Group | Version | Kind |
|---|---|---|
apiextensions.k8s.io | v1beta1 | CustomResourceValidation |
CustomResourceValidation is a list of validation methods for CustomResources.
+| Field | Description |
|---|---|
openAPIV3SchemaJSONSchemaProps | OpenAPIV3Schema is the OpenAPI v3 schema to be validated against. |
| Group | Version | Kind |
|---|---|---|
core | v1 | DaemonEndpoint |
DaemonEndpoint contains information about a single Daemon endpoint.
+| Field | Description |
|---|---|
Portinteger | Port number of the given endpoint. |
| Group | Version | Kind |
|---|---|---|
apps | v1 | DaemonSetCondition |
DaemonSetCondition describes the state of a DaemonSet at a certain point.
+ +| Field | Description |
|---|---|
lastTransitionTimeTime | Last time the condition transitioned from one status to another. |
messagestring | A human readable message indicating details about the transition. |
reasonstring | The reason for the condition's last transition. |
statusstring | Status of the condition, one of True, False, Unknown. |
typestring | Type of DaemonSet condition. |
| Group | Version | Kind |
|---|---|---|
apps | v1 | DaemonSetUpdateStrategy |
DaemonSetUpdateStrategy is a struct used to control the update strategy for a DaemonSet.
+ +| Field | Description |
|---|---|
rollingUpdateRollingUpdateDaemonSet | Rolling update config params. Present only if type = "RollingUpdate". |
typestring | Type of daemon set update. Can be "RollingUpdate" or "OnDelete". Default is RollingUpdate. |
| Group | Version | Kind |
|---|---|---|
meta | v1 | DeleteOptions |
DeleteOptions may be provided when deleting an API object.
+| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
dryRunstring array | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSecondsinteger | 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. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
orphanDependentsboolean | 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. |
preconditionsPreconditions | Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned. |
propagationPolicystring | 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. |
| Group | Version | Kind |
|---|---|---|
apps | v1 | DeploymentCondition |
DeploymentCondition describes the state of a deployment at a certain point.
+ +| Field | Description |
|---|---|
lastTransitionTimeTime | Last time the condition transitioned from one status to another. |
lastUpdateTimeTime | The last time this condition was updated. |
messagestring | A human readable message indicating details about the transition. |
reasonstring | The reason for the condition's last transition. |
statusstring | Status of the condition, one of True, False, Unknown. |
typestring | Type of deployment condition. |
| Group | Version | Kind |
|---|---|---|
core | v1 | DownwardAPIProjection |
Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode.
+| Field | Description |
|---|---|
itemsDownwardAPIVolumeFile array | Items is a list of DownwardAPIVolume file |
| Group | Version | Kind |
|---|---|---|
core | v1 | DownwardAPIVolumeFile |
DownwardAPIVolumeFile represents information to create the file containing the pod field
+| Field | Description |
|---|---|
fieldRefObjectFieldSelector | Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. |
modeinteger | 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. |
pathstring | 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 '..' |
resourceFieldRefResourceFieldSelector | Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. |
| Group | Version | Kind |
|---|---|---|
core | v1 | DownwardAPIVolumeSource |
DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.
+| Field | Description |
|---|---|
defaultModeinteger | 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. |
itemsDownwardAPIVolumeFile array | Items is a list of downward API volume file |
| Group | Version | Kind |
|---|---|---|
core | v1 | EmptyDirVolumeSource |
Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.
+| Field | Description |
|---|---|
mediumstring | What type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir |
sizeLimitQuantity | Total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir |
| Group | Version | Kind |
|---|---|---|
core | v1 | EndpointAddress |
EndpointAddress is a tuple that describes single IP address.
+| Field | Description |
|---|---|
hostnamestring | The Hostname of this endpoint |
ipstring | The IP of this endpoint. May not be loopback (127.0.0.0/8), link-local (169.254.0.0/16), or link-local multicast ((224.0.0.0/24). IPv6 is also accepted but not fully supported on all platforms. Also, certain kubernetes components, like kube-proxy, are not IPv6 ready. |
nodeNamestring | Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node. |
targetRefObjectReference | Reference to object providing the endpoint. |
| Group | Version | Kind |
|---|---|---|
core | v1 | EndpointPort |
EndpointPort is a tuple that describes a single port.
+| Field | Description |
|---|---|
namestring | The name of this port (corresponds to ServicePort.Name). Must be a DNS_LABEL. Optional only if one port is defined. |
portinteger | The port number of the endpoint. |
protocolstring | The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP. |
| Group | Version | Kind |
|---|---|---|
core | v1 | EndpointSubset |
EndpointSubset is a group of addresses with a common set of ports. The expanded set of endpoints is the Cartesian product of Addresses x Ports. For example, given: + { + Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], + Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] + } +The resulting set of endpoints can be viewed as: + a: [ 10.10.1.1:8675, 10.10.2.2:8675 ], + b: [ 10.10.1.1:309, 10.10.2.2:309 ]
+| Field | Description |
|---|---|
addressesEndpointAddress array | IP addresses which offer the related ports that are marked as ready. These endpoints should be considered safe for load balancers and clients to utilize. |
notReadyAddressesEndpointAddress array | IP addresses which offer the related ports but are not currently marked as ready because they have not yet finished starting, have recently failed a readiness check, or have recently failed a liveness check. |
portsEndpointPort array | Port numbers available on the related IP addresses. |
| Group | Version | Kind |
|---|---|---|
core | v1 | EnvFromSource |
EnvFromSource represents the source of a set of ConfigMaps
+| Field | Description |
|---|---|
configMapRefConfigMapEnvSource | The ConfigMap to select from |
prefixstring | An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. |
secretRefSecretEnvSource | The Secret to select from |
| Group | Version | Kind |
|---|---|---|
core | v1 | EnvVar |
EnvVar represents an environment variable present in a Container.
+| Field | Description |
|---|---|
namestring | Name of the environment variable. Must be a C_IDENTIFIER. |
valuestring | Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". |
valueFromEnvVarSource | Source for the environment variable's value. Cannot be used if value is not empty. |
| Group | Version | Kind |
|---|---|---|
core | v1 | EnvVarSource |
EnvVarSource represents a source for the value of an EnvVar.
+| Field | Description |
|---|---|
configMapKeyRefConfigMapKeySelector | Selects a key of a ConfigMap. |
fieldRefObjectFieldSelector | Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP. |
resourceFieldRefResourceFieldSelector | Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. |
secretKeyRefSecretKeySelector | Selects a key of a secret in the pod's namespace |
| Group | Version | Kind |
|---|---|---|
core | v1 | EventSeries |
EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time.
+| Field | Description |
|---|---|
countinteger | Number of occurrences in this series up to the last heartbeat time |
lastObservedTimeMicroTime | Time of the last occurrence observed |
statestring | State of this Series: Ongoing or Finished |
| Group | Version | Kind |
|---|---|---|
core | v1 | EventSource |
EventSource contains information for an event.
+| Field | Description |
|---|---|
componentstring | Component from which the event is generated. |
hoststring | Node name on which the event is generated. |
| Group | Version | Kind |
|---|---|---|
policy | v1beta1 | Eviction |
Eviction evicts a pod from its node subject to certain policies and safety constraints. This is a subresource of Pod. A request to cause such an eviction is created by POSTing to .../pods/<pod name>/evictions.
+| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
deleteOptionsDeleteOptions | DeleteOptions may be provided |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | ObjectMeta describes the pod that is being evicted. |
| Group | Version | Kind |
|---|---|---|
core | v1 | ExecAction |
ExecAction describes a "run in container" action.
+| Field | Description |
|---|---|
commandstring array | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
| Group | Version | Kind |
|---|---|---|
apiextensions.k8s.io | v1beta1 | ExternalDocumentation |
ExternalDocumentation allows referencing an external resource for extended documentation.
+| Field | Description |
|---|---|
descriptionstring | |
urlstring |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta2 | ExternalMetricSource |
ExternalMetricSource indicates how to scale on a metric not associated with any Kubernetes object (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).
+| Field | Description |
|---|---|
metricMetricIdentifier | metric identifies the target metric by name and selector |
targetMetricTarget | target specifies the target value for the given metric |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta2 | ExternalMetricStatus |
ExternalMetricStatus indicates the current value of a global metric not associated with any Kubernetes object.
+| Field | Description |
|---|---|
currentMetricValueStatus | current contains the current value for the given metric |
metricMetricIdentifier | metric identifies the target metric by name and selector |
| Group | Version | Kind |
|---|---|---|
core | v1 | FCVolumeSource |
Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.
+| Field | Description |
|---|---|
fsTypestring | 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. |
luninteger | Optional: FC target lun number |
readOnlyboolean | Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
targetWWNsstring array | Optional: FC target worldwide names (WWNs) |
wwidsstring array | Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously. |
| Group | Version | Kind |
|---|---|---|
extensions | v1beta1 | FSGroupStrategyOptions |
FSGroupStrategyOptions defines the strategy type and options used to create the strategy. Deprecated: use FSGroupStrategyOptions from policy API Group instead.
+| Field | Description |
|---|---|
rangesIDRange array | ranges are the allowed ranges of fs groups. If you would like to force a single fs group then supply a single range with the same start and end. Required for MustRunAs. |
rulestring | rule is the strategy that will dictate what FSGroup is used in the SecurityContext. |
| Group | Version | Kind |
|---|---|---|
core | v1 | FlexPersistentVolumeSource |
FlexPersistentVolumeSource represents a generic persistent volume resource that is provisioned/attached using an exec based plugin.
+| Field | Description |
|---|---|
driverstring | Driver is the name of the driver to use for this volume. |
fsTypestring | Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. |
optionsobject | Optional: Extra command options if any. |
readOnlyboolean | Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
secretRefSecretReference | Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts. |
| Group | Version | Kind |
|---|---|---|
core | v1 | FlexVolumeSource |
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
+| Field | Description |
|---|---|
driverstring | Driver is the name of the driver to use for this volume. |
fsTypestring | Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. |
optionsobject | Optional: Extra command options if any. |
readOnlyboolean | Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
secretRefLocalObjectReference | Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts. |
| Group | Version | Kind |
|---|---|---|
core | v1 | FlockerVolumeSource |
Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.
+| Field | Description |
|---|---|
datasetNamestring | Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated |
datasetUUIDstring | UUID of the dataset. This is unique identifier of a Flocker dataset |
| Group | Version | Kind |
|---|---|---|
core | v1 | GCEPersistentDiskVolumeSource |
Represents a Persistent Disk resource in Google Compute Engine. + +A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.
+| Field | Description |
|---|---|
fsTypestring | 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#gcepersistentdisk |
partitioninteger | 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). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
pdNamestring | Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
readOnlyboolean | ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
| Group | Version | Kind |
|---|---|---|
core | v1 | GitRepoVolumeSource |
Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling. + +DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.
+| Field | Description |
|---|---|
directorystring | Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. |
repositorystring | Repository URL |
revisionstring | Commit hash for the specified revision. |
| Group | Version | Kind |
|---|---|---|
core | v1 | GlusterfsPersistentVolumeSource |
Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.
+| Field | Description |
|---|---|
endpointsstring | EndpointsName is the endpoint name that details Glusterfs topology. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod |
endpointsNamespacestring | EndpointsNamespace is the namespace that contains Glusterfs endpoint. If this field is empty, the EndpointNamespace defaults to the same namespace as the bound PVC. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod |
pathstring | Path is the Glusterfs volume path. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod |
readOnlyboolean | ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod |
| Group | Version | Kind |
|---|---|---|
core | v1 | GlusterfsVolumeSource |
Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.
+| Field | Description |
|---|---|
endpointsstring | EndpointsName is the endpoint name that details Glusterfs topology. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod |
pathstring | Path is the Glusterfs volume path. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod |
readOnlyboolean | ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod |
| Group | Version | Kind |
|---|---|---|
meta | v1 | GroupVersionForDiscovery |
GroupVersion contains the "group/version" and "version" string of a version. It is made a struct to keep extensibility.
+| Field | Description |
|---|---|
groupVersionstring | groupVersion specifies the API group and version in the form "group/version" |
versionstring | version specifies the version in the form of "version". This is to save the clients the trouble of splitting the GroupVersion. |
| Group | Version | Kind |
|---|---|---|
core | v1 | HTTPGetAction |
HTTPGetAction describes an action based on HTTP Get requests.
+| Field | Description |
|---|---|
hoststring | Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
httpHeadersHTTPHeader array | Custom headers to set in the request. HTTP allows repeated headers. |
pathstring | Path to access on the HTTP server. |
port | Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
schemestring | Scheme to use for connecting to the host. Defaults to HTTP. |
| Group | Version | Kind |
|---|---|---|
core | v1 | HTTPHeader |
HTTPHeader describes a custom header to be used in HTTP probes
+| Field | Description |
|---|---|
namestring | The header field name |
valuestring | The header field value |
| Group | Version | Kind |
|---|---|---|
extensions | v1beta1 | HTTPIngressPath |
HTTPIngressPath associates a path regex with a backend. Incoming urls matching the path are forwarded to the backend.
+| Field | Description |
|---|---|
backendIngressBackend | Backend defines the referenced service endpoint to which the traffic will be forwarded to. |
pathstring | Path is an extended POSIX regex as defined by IEEE Std 1003.1, (i.e this follows the egrep/unix syntax, not the perl syntax) matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a '/'. If unspecified, the path defaults to a catch all sending traffic to the backend. |
| Group | Version | Kind |
|---|---|---|
extensions | v1beta1 | HTTPIngressRuleValue |
HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http://<host>/<path>?<searchpart> -> backend where where parts of the url correspond to RFC 3986, this resource will be used to match against everything after the last '/' and before the first '?' or '#'.
+| Field | Description |
|---|---|
pathsHTTPIngressPath array | A collection of paths that map requests to backends. |
| Group | Version | Kind |
|---|---|---|
core | v1 | Handler |
Handler defines a specific action that should be taken
+| Field | Description |
|---|---|
execExecAction | One and only one of the following should be specified. Exec specifies the action to take. |
httpGetHTTPGetAction | HTTPGet specifies the http request to perform. |
tcpSocketTCPSocketAction | TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta2 | HorizontalPodAutoscalerCondition |
HorizontalPodAutoscalerCondition describes the state of a HorizontalPodAutoscaler at a certain point.
+| Field | Description |
|---|---|
lastTransitionTimeTime | lastTransitionTime is the last time the condition transitioned from one status to another |
messagestring | message is a human-readable explanation containing details about the transition |
reasonstring | reason is the reason for the condition's last transition. |
statusstring | status is the status of the condition (True, False, Unknown) |
typestring | type describes the current condition |
| Group | Version | Kind |
|---|---|---|
core | v1 | HostAlias |
HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.
+| Field | Description |
|---|---|
hostnamesstring array | Hostnames for the above IP address. |
ipstring | IP address of the host file entry. |
| Group | Version | Kind |
|---|---|---|
core | v1 | HostPathVolumeSource |
Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.
+| Field | Description |
|---|---|
pathstring | Path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |
typestring | Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |
| Group | Version | Kind |
|---|---|---|
extensions | v1beta1 | HostPortRange |
HostPortRange defines a range of host ports that will be enabled by a policy for pods to use. It requires both the start and end to be defined. Deprecated: use HostPortRange from policy API Group instead.
+| Field | Description |
|---|---|
maxinteger | max is the end of the range, inclusive. |
mininteger | min is the start of the range, inclusive. |
| Group | Version | Kind |
|---|---|---|
extensions | v1beta1 | IDRange |
IDRange provides a min/max of an allowed range of IDs. Deprecated: use IDRange from policy API Group instead.
+| Field | Description |
|---|---|
maxinteger | max is the end of the range, inclusive. |
mininteger | min is the start of the range, inclusive. |
| Group | Version | Kind |
|---|---|---|
networking.k8s.io | 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.
+| Field | Description |
|---|---|
cidrstring | CIDR is a string representing the IP Block Valid examples are "192.168.1.1/24" |
exceptstring 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 |
| Group | Version | Kind |
|---|---|---|
core | v1 | ISCSIPersistentVolumeSource |
ISCSIPersistentVolumeSource represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.
+| Field | Description |
|---|---|
chapAuthDiscoveryboolean | whether support iSCSI Discovery CHAP authentication |
chapAuthSessionboolean | whether support iSCSI Session CHAP authentication |
fsTypestring | 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#iscsi |
initiatorNamestring | Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection. |
iqnstring | Target iSCSI Qualified Name. |
iscsiInterfacestring | iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp). |
luninteger | iSCSI Target Lun number. |
portalsstring array | iSCSI Target Portal List. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). |
readOnlyboolean | ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. |
secretRefSecretReference | CHAP Secret for iSCSI target and initiator authentication |
targetPortalstring | iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). |
| Group | Version | Kind |
|---|---|---|
core | v1 | ISCSIVolumeSource |
Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.
+| Field | Description |
|---|---|
chapAuthDiscoveryboolean | whether support iSCSI Discovery CHAP authentication |
chapAuthSessionboolean | whether support iSCSI Session CHAP authentication |
fsTypestring | 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#iscsi |
initiatorNamestring | Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection. |
iqnstring | Target iSCSI Qualified Name. |
iscsiInterfacestring | iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp). |
luninteger | iSCSI Target Lun number. |
portalsstring array | iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). |
readOnlyboolean | ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. |
secretRefLocalObjectReference | CHAP Secret for iSCSI target and initiator authentication |
targetPortalstring | iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). |
| Group | Version | Kind |
|---|---|---|
extensions | v1beta1 | IngressBackend |
IngressBackend describes all endpoints for a given service and port.
+| Field | Description |
|---|---|
serviceNamestring | Specifies the name of the referenced service. |
servicePort | Specifies the port of the referenced service. |
| Group | Version | Kind |
|---|---|---|
extensions | v1beta1 | IngressRule |
IngressRule represents the rules mapping the paths under a specified host to the related backend services. Incoming requests are first evaluated for a host match, then routed to the backend associated with the matching IngressRuleValue.
+| Field | Description |
|---|---|
hoststring | Host is the fully qualified domain name of a network host, as defined by RFC 3986. Note the following deviations from the "host" part of the URI as defined in the RFC: 1. IPs are not allowed. Currently an IngressRuleValue can only apply to the IP in the Spec of the parent Ingress. 2. The `:` delimiter is not respected because ports are not allowed. Currently the port of an Ingress is implicitly :80 for http and :443 for https. Both these may change in the future. Incoming requests are matched against the host before the IngressRuleValue. If the host is unspecified, the Ingress routes all traffic based on the specified IngressRuleValue. |
httpHTTPIngressRuleValue |
| Group | Version | Kind |
|---|---|---|
extensions | v1beta1 | IngressTLS |
IngressTLS describes the transport layer security associated with an Ingress.
+| Field | Description |
|---|---|
hostsstring array | Hosts are a list of hosts included in the TLS certificate. The values in this list must match the name/s used in the tlsSecret. Defaults to the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified. |
secretNamestring | SecretName is the name of the secret used to terminate SSL traffic on 443. Field is left optional to allow SSL routing based on SNI hostname alone. If the SNI host in a listener conflicts with the "Host" header field used by an IngressRule, the SNI host is used for termination and value of the Host header is used for routing. |
| Group | Version | Kind |
|---|---|---|
meta | v1 | Initializer |
Initializer is information about an initializer that has not yet completed.
+| Field | Description |
|---|---|
namestring | name of the process that is responsible for initializing this object. |
| Group | Version | Kind |
|---|---|---|
meta | v1 | Initializers |
Initializers tracks the progress of initialization.
+| Field | Description |
|---|---|
pendingInitializer array patch strategy: merge patch merge key: name | Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients. |
resultStatus | If result is set with the Failure field, the object will be persisted to storage and then deleted, ensuring that other clients can observe the deletion. |
| Group | Version | Kind |
|---|---|---|
apiextensions.k8s.io | v1beta1 | JSON |
JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+| Field | Description |
|---|
| Group | Version | Kind |
|---|---|---|
apiextensions.k8s.io | v1beta1 | JSONSchemaProps |
JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/).
+| Field | Description |
|---|---|
$refstring | |
$schemastring | |
additionalItemsJSONSchemaPropsOrBool | |
additionalPropertiesJSONSchemaPropsOrBool | |
allOfJSONSchemaProps array | |
anyOfJSONSchemaProps array | |
defaultJSON | |
definitionsobject | |
dependenciesobject | |
descriptionstring | |
enumJSON array | |
exampleJSON | |
exclusiveMaximumboolean | |
exclusiveMinimumboolean | |
externalDocsExternalDocumentation | |
formatstring | |
idstring | |
itemsJSONSchemaPropsOrArray | |
maxItemsinteger | |
maxLengthinteger | |
maxPropertiesinteger | |
maximumnumber | |
minItemsinteger | |
minLengthinteger | |
minPropertiesinteger | |
minimumnumber | |
multipleOfnumber | |
notJSONSchemaProps | |
oneOfJSONSchemaProps array | |
patternstring | |
patternPropertiesobject | |
propertiesobject | |
requiredstring array | |
titlestring | |
typestring | |
uniqueItemsboolean |
| Group | Version | Kind |
|---|---|---|
apiextensions.k8s.io | v1beta1 | JSONSchemaPropsOrArray |
JSONSchemaPropsOrArray represents a value that can either be a JSONSchemaProps or an array of JSONSchemaProps. Mainly here for serialization purposes.
+| Field | Description |
|---|
| Group | Version | Kind |
|---|---|---|
apiextensions.k8s.io | v1beta1 | JSONSchemaPropsOrBool |
JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. Defaults to true for the boolean property.
+| Field | Description |
|---|
| Group | Version | Kind |
|---|---|---|
batch | v1 | JobCondition |
JobCondition describes current state of a job.
+| Field | Description |
|---|---|
lastProbeTimeTime | Last time the condition was checked. |
lastTransitionTimeTime | Last time the condition transit from one status to another. |
messagestring | Human readable message indicating details about last transition. |
reasonstring | (brief) reason for the condition's last transition. |
statusstring | Status of the condition, one of True, False, Unknown. |
typestring | Type of job condition, Complete or Failed. |
| Group | Version | Kind |
|---|---|---|
batch | v1beta1 | JobTemplateSpec |
JobTemplateSpec describes the data a Job should have when created from a template
+| Field | Description |
|---|---|
metadataObjectMeta | Standard object's metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
specJobSpec | Specification of the desired behavior of the job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
| Group | Version | Kind |
|---|---|---|
core | v1 | KeyToPath |
Maps a string key to a path within a volume.
+| Field | Description |
|---|---|
keystring | The key to project. |
modeinteger | 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. |
pathstring | The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. |
| Group | Version | Kind |
|---|---|---|
meta | v1 | LabelSelector |
A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
+| Field | Description |
|---|---|
matchExpressionsLabelSelectorRequirement array | matchExpressions is a list of label selector requirements. The requirements are ANDed. |
matchLabelsobject | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
| Group | Version | Kind |
|---|---|---|
meta | v1 | LabelSelectorRequirement |
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+| Field | Description |
|---|---|
keystring patch strategy: merge patch merge key: key | key is the label key that the selector applies to. |
operatorstring | operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
valuesstring array | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
| Group | Version | Kind |
|---|---|---|
coordination.k8s.io | v1beta1 | Lease |
Lease defines a lease concept.
+| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
specLeaseSpec | Specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
| Group | Version | Kind |
|---|---|---|
core | v1 | Lifecycle |
Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.
+| Field | Description |
|---|---|
postStartHandler | PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks |
preStopHandler | PreStop is called immediately before a container is terminated. The container is terminated after the handler completes. The reason for termination is passed to the handler. Regardless of the outcome of the handler, the container is eventually terminated. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks |
| Group | Version | Kind |
|---|---|---|
core | v1 | LimitRangeItem |
LimitRangeItem defines a min/max usage limit for any resource that matches on kind.
+| Field | Description |
|---|---|
defaultobject | Default resource requirement limit value by resource name if resource limit is omitted. |
defaultRequestobject | DefaultRequest is the default resource requirement request value by resource name if resource request is omitted. |
maxobject | Max usage constraints on this kind by resource name. |
maxLimitRequestRatioobject | MaxLimitRequestRatio if specified, the named resource must have a request and limit that are both non-zero where limit divided by request is less than or equal to the enumerated value; this represents the max burst for the named resource. |
minobject | Min usage constraints on this kind by resource name. |
typestring | Type of resource that this limit applies to. |
| Group | Version | Kind |
|---|---|---|
meta | v1 | ListMeta |
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
+| Field | Description |
|---|---|
continuestring | continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message. |
resourceVersionstring | String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
selfLinkstring | selfLink is a URL representing this object. Populated by the system. Read-only. |
| Group | Version | Kind |
|---|---|---|
core | v1 | LoadBalancerIngress |
LoadBalancerIngress represents the status of a load-balancer ingress point: traffic intended for the service should be sent to an ingress point.
+| Field | Description |
|---|---|
hostnamestring | Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers) |
ipstring | IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers) |
| Group | Version | Kind |
|---|---|---|
core | v1 | LoadBalancerStatus |
LoadBalancerStatus represents the status of a load-balancer.
+| Field | Description |
|---|---|
ingressLoadBalancerIngress array | Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points. |
| Group | Version | Kind |
|---|---|---|
core | v1 | LocalObjectReference |
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
+| Field | Description |
|---|---|
namestring | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| Group | Version | Kind |
|---|---|---|
core | v1 | LocalVolumeSource |
Local represents directly-attached storage with node affinity (Beta feature)
+| Field | Description |
|---|---|
fsTypestring | Filesystem type to mount. It applies only when the Path is a block device. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default value is to auto-select a fileystem if unspecified. |
pathstring | The full path to the volume on the node. It can be either a directory or block device (disk, partition, ...). |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta2 | MetricIdentifier |
MetricIdentifier defines the name and optionally selector for a metric
+| Field | Description |
|---|---|
namestring | name is the name of the given metric |
selectorLabelSelector | selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics. |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta2 | MetricSpec |
MetricSpec specifies how to scale based on a single metric (only `type` and one other matching field should be set at once).
+| Field | Description |
|---|---|
externalExternalMetricSource | external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster). |
objectObjectMetricSource | object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object). |
podsPodsMetricSource | pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value. |
resourceResourceMetricSource | resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. |
typestring | type is the type of metric source. It should be one of "Object", "Pods" or "Resource", each mapping to a matching field in the object. |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta2 | MetricStatus |
MetricStatus describes the last-read state of a single metric.
+| Field | Description |
|---|---|
externalExternalMetricStatus | external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster). |
objectObjectMetricStatus | object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object). |
podsPodsMetricStatus | pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value. |
resourceResourceMetricStatus | resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. |
typestring | type is the type of metric source. It will be one of "Object", "Pods" or "Resource", each corresponds to a matching field in the object. |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta2 | MetricTarget |
MetricTarget defines the target value, average value, or average utilization of a specific metric
+| Field | Description |
|---|---|
averageUtilizationinteger | averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type |
averageValueQuantity | averageValue is the target value of the average of the metric across all relevant pods (as a quantity) |
typestring | type represents whether the metric type is Utilization, Value, or AverageValue |
valueQuantity | value is the target value of the metric (as a quantity). |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta2 | MetricValueStatus |
MetricValueStatus holds the current value for a metric
+| Field | Description |
|---|---|
averageUtilizationinteger | currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. |
averageValueQuantity | averageValue is the current value of the average of the metric across all relevant pods (as a quantity) |
valueQuantity | value is the current value of the metric (as a quantity). |
| Group | Version | Kind |
|---|---|---|
meta | v1 | MicroTime |
MicroTime is version of Time with microsecond level precision.
+| Field | Description |
|---|
| Group | Version | Kind |
|---|---|---|
core | v1 | NFSVolumeSource |
Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.
+| Field | Description |
|---|---|
pathstring | Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
readOnlyboolean | ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
serverstring | Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
| Group | Version | Kind |
|---|---|---|
networking.k8s.io | 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
+| Field | Description |
|---|---|
portsNetworkPolicyPort array | 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. |
toNetworkPolicyPeer array | 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. |
| Group | Version | Kind |
|---|---|---|
networking.k8s.io | v1 | NetworkPolicyIngressRule |
NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from.
+| Field | Description |
|---|---|
fromNetworkPolicyPeer array | 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. |
portsNetworkPolicyPort array | 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. |
| Group | Version | Kind |
|---|---|---|
networking.k8s.io | v1 | NetworkPolicyPeer |
NetworkPolicyPeer describes a peer to allow traffic from. Only certain combinations of fields are allowed
+| Field | Description |
|---|---|
ipBlockIPBlock | IPBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be. |
namespaceSelectorLabelSelector | Selects Namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces. If PodSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects all Pods in the Namespaces selected by NamespaceSelector. |
podSelectorLabelSelector | This is a label selector which selects Pods. This field follows standard label selector semantics; if present but empty, it selects all pods. If NamespaceSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects the Pods matching PodSelector in the policy's own Namespace. |
| Group | Version | Kind |
|---|---|---|
networking.k8s.io | v1 | NetworkPolicyPort |
NetworkPolicyPort describes a port to allow traffic on
+| Field | Description |
|---|---|
port | 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. |
protocolstring | The protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP. |
| Group | Version | Kind |
|---|---|---|
core | v1 | NodeAddress |
NodeAddress contains information for the node's address.
+| Field | Description |
|---|---|
addressstring | The node address. |
typestring | Node address type, one of Hostname, ExternalIP or InternalIP. |
| Group | Version | Kind |
|---|---|---|
core | v1 | NodeAffinity |
Node affinity is a group of node affinity scheduling rules.
+| Field | Description |
|---|---|
preferredDuringSchedulingIgnoredDuringExecutionPreferredSchedulingTerm array | The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. |
requiredDuringSchedulingIgnoredDuringExecutionNodeSelector | If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node. |
| Group | Version | Kind |
|---|---|---|
core | v1 | NodeCondition |
NodeCondition contains condition information for a node.
+| Field | Description |
|---|---|
lastHeartbeatTimeTime | Last time we got an update on a given condition. |
lastTransitionTimeTime | Last time the condition transit from one status to another. |
messagestring | Human readable message indicating details about last transition. |
reasonstring | (brief) reason for the condition's last transition. |
statusstring | Status of the condition, one of True, False, Unknown. |
typestring | Type of node condition. |
| Group | Version | Kind |
|---|---|---|
core | v1 | NodeConfigSource |
NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil.
+| Field | Description |
|---|---|
configMapConfigMapNodeConfigSource | ConfigMap is a reference to a Node's ConfigMap |
| Group | Version | Kind |
|---|---|---|
core | v1 | NodeConfigStatus |
NodeConfigStatus describes the status of the config assigned by Node.Spec.ConfigSource.
+| Field | Description |
|---|---|
activeNodeConfigSource | Active reports the checkpointed config the node is actively using. Active will represent either the current version of the Assigned config, or the current LastKnownGood config, depending on whether attempting to use the Assigned config results in an error. |
assignedNodeConfigSource | Assigned reports the checkpointed config the node will try to use. When Node.Spec.ConfigSource is updated, the node checkpoints the associated config payload to local disk, along with a record indicating intended config. The node refers to this record to choose its config checkpoint, and reports this record in Assigned. Assigned only updates in the status after the record has been checkpointed to disk. When the Kubelet is restarted, it tries to make the Assigned config the Active config by loading and validating the checkpointed payload identified by Assigned. |
errorstring | Error describes any problems reconciling the Spec.ConfigSource to the Active config. Errors may occur, for example, attempting to checkpoint Spec.ConfigSource to the local Assigned record, attempting to checkpoint the payload associated with Spec.ConfigSource, attempting to load or validate the Assigned config, etc. Errors may occur at different points while syncing config. Earlier errors (e.g. download or checkpointing errors) will not result in a rollback to LastKnownGood, and may resolve across Kubelet retries. Later errors (e.g. loading or validating a checkpointed config) will result in a rollback to LastKnownGood. In the latter case, it is usually possible to resolve the error by fixing the config assigned in Spec.ConfigSource. You can find additional information for debugging by searching the error message in the Kubelet log. Error is a human-readable description of the error state; machines can check whether or not Error is empty, but should not rely on the stability of the Error text across Kubelet versions. |
lastKnownGoodNodeConfigSource | LastKnownGood reports the checkpointed config the node will fall back to when it encounters an error attempting to use the Assigned config. The Assigned config becomes the LastKnownGood config when the node determines that the Assigned config is stable and correct. This is currently implemented as a 10-minute soak period starting when the local record of Assigned config is updated. If the Assigned config is Active at the end of this period, it becomes the LastKnownGood. Note that if Spec.ConfigSource is reset to nil (use local defaults), the LastKnownGood is also immediately reset to nil, because the local default config is always assumed good. You should not make assumptions about the node's method of determining config stability and correctness, as this may change or become configurable in the future. |
| Group | Version | Kind |
|---|---|---|
core | v1 | NodeDaemonEndpoints |
NodeDaemonEndpoints lists ports opened by daemons running on the Node.
+| Field | Description |
|---|---|
kubeletEndpointDaemonEndpoint | Endpoint on which Kubelet is listening. |
| Group | Version | Kind |
|---|---|---|
core | v1 | NodeSelector |
A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.
+| Field | Description |
|---|---|
nodeSelectorTermsNodeSelectorTerm array | Required. A list of node selector terms. The terms are ORed. |
| Group | Version | Kind |
|---|---|---|
core | v1 | NodeSelectorRequirement |
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+| Field | Description |
|---|---|
keystring | The label key that the selector applies to. |
operatorstring | Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
valuesstring array | An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
| Group | Version | Kind |
|---|---|---|
core | v1 | NodeSelectorTerm |
A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.
+| Field | Description |
|---|---|
matchExpressionsNodeSelectorRequirement array | A list of node selector requirements by node's labels. |
matchFieldsNodeSelectorRequirement array | A list of node selector requirements by node's fields. |
| Group | Version | Kind |
|---|---|---|
core | v1 | NodeSystemInfo |
NodeSystemInfo is a set of ids/uuids to uniquely identify the node.
+| Field | Description |
|---|---|
architecturestring | The Architecture reported by the node |
bootIDstring | Boot ID reported by the node. |
containerRuntimeVersionstring | ContainerRuntime Version reported by the node through runtime remote API (e.g. docker://1.5.0). |
kernelVersionstring | Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64). |
kubeProxyVersionstring | KubeProxy Version reported by the node. |
kubeletVersionstring | Kubelet Version reported by the node. |
machineIDstring | MachineID reported by the node. For unique machine identification in the cluster this field is preferred. Learn more from man(5) machine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html |
operatingSystemstring | The Operating System reported by the node |
osImagestring | OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)). |
systemUUIDstring | SystemUUID reported by the node. For unique machine identification MachineID is preferred. This field is specific to Red Hat hosts https://access.redhat.com/documentation/en-US/Red_Hat_Subscription_Management/1/html/RHSM/getting-system-uuid.html |
| Group | Version | Kind |
|---|---|---|
authorization.k8s.io | v1 | NonResourceAttributes |
NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface
+| Field | Description |
|---|---|
pathstring | Path is the URL path of the request |
verbstring | Verb is the standard HTTP verb |
| Group | Version | Kind |
|---|---|---|
authorization.k8s.io | v1 | NonResourceRule |
NonResourceRule holds information that describes a rule for the non-resource
+| Field | Description |
|---|---|
nonResourceURLsstring 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. |
verbsstring array | Verb is a list of kubernetes non-resource API verbs, like: get, post, put, delete, patch, head, options. "*" means all. |
| Group | Version | Kind |
|---|---|---|
core | v1 | ObjectFieldSelector |
ObjectFieldSelector selects an APIVersioned field of an object.
+| Field | Description |
|---|---|
apiVersionstring | Version of the schema the FieldPath is written in terms of, defaults to "v1". |
fieldPathstring | Path of the field to select in the specified API version. |
| Group | Version | Kind |
|---|---|---|
meta | v1 | ObjectMeta |
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
+| Field | Description |
|---|---|
annotationsobject | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations |
clusterNamestring | The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request. |
creationTimestampTime | CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
deletionGracePeriodSecondsinteger | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. |
deletionTimestampTime | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
finalizersstring array patch strategy: merge | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. |
generateNamestring | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
generationinteger | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. |
initializersInitializers | An initializer is a controller which enforces some system invariant at object creation time. This field is a list of initializers that have not yet acted on this object. If nil or empty, this object has been completely initialized. Otherwise, the object is considered uninitialized and is hidden (in list/watch and get calls) from clients that haven't explicitly asked to observe uninitialized objects. When an object is created, the system will populate this list with the current set of initializers. Only privileged users may set or modify this list. Once it is empty, it may not be modified further by any user. |
labelsobject | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels |
namestring | Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names |
namespacestring | Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces |
ownerReferencesOwnerReference array patch strategy: merge patch merge key: uid | List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. |
resourceVersionstring | An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
selfLinkstring | SelfLink is a URL representing this object. Populated by the system. Read-only. |
uidstring | UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta2 | ObjectMetricSource |
ObjectMetricSource indicates how to scale on a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).
+| Field | Description |
|---|---|
describedObjectCrossVersionObjectReference | |
metricMetricIdentifier | metric identifies the target metric by name and selector |
targetMetricTarget | target specifies the target value for the given metric |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta2 | ObjectMetricStatus |
ObjectMetricStatus indicates the current value of a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).
+| Field | Description |
|---|---|
currentMetricValueStatus | current contains the current value for the given metric |
describedObjectCrossVersionObjectReference | |
metricMetricIdentifier | metric identifies the target metric by name and selector |
| Group | Version | Kind |
|---|---|---|
core | v1 | ObjectReference |
ObjectReference contains enough information to let you inspect or modify the referred object.
+| Field | Description |
|---|---|
apiVersionstring | API version of the referent. |
fieldPathstring | If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. |
kindstring | Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
namestring | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
namespacestring | Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
resourceVersionstring | Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
uidstring | UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
| Group | Version | Kind |
|---|---|---|
meta | v1 | OwnerReference |
OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.
+| Field | Description |
|---|---|
apiVersionstring | API version of the referent. |
blockOwnerDeletionboolean | If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. |
controllerboolean | If true, this reference points to the managing controller. |
kindstring | Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
namestring | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names |
uidstring | UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| Group | Version | Kind |
|---|---|---|
meta | v1 | Patch |
Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.
+| Field | Description |
|---|
| Group | Version | Kind |
|---|---|---|
core | v1 | PersistentVolumeClaimCondition |
PersistentVolumeClaimCondition contails details about state of pvc
+| Field | Description |
|---|---|
lastProbeTimeTime | Last time we probed the condition. |
lastTransitionTimeTime | Last time the condition transitioned from one status to another. |
messagestring | Human-readable message indicating details about last transition. |
reasonstring | Unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports "ResizeStarted" that means the underlying persistent volume is being resized. |
statusstring | |
typestring |
| Group | Version | Kind |
|---|---|---|
core | v1 | PersistentVolumeClaimVolumeSource |
PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).
+| Field | Description |
|---|---|
claimNamestring | ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
readOnlyboolean | Will force the ReadOnly setting in VolumeMounts. Default false. |
| Group | Version | Kind |
|---|---|---|
core | v1 | PhotonPersistentDiskVolumeSource |
Represents a Photon Controller persistent disk resource.
+| Field | Description |
|---|---|
fsTypestring | 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. |
pdIDstring | ID that identifies Photon Controller persistent disk |
| Group | Version | Kind |
|---|---|---|
core | v1 | PodAffinity |
Pod affinity is a group of inter pod affinity scheduling rules.
+| Field | Description |
|---|---|
preferredDuringSchedulingIgnoredDuringExecutionWeightedPodAffinityTerm array | The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. |
requiredDuringSchedulingIgnoredDuringExecutionPodAffinityTerm array | If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. |
| Group | Version | Kind |
|---|---|---|
core | v1 | PodAffinityTerm |
Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
+| Field | Description |
|---|---|
labelSelectorLabelSelector | A label query over a set of resources, in this case pods. |
namespacesstring array | namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace" |
topologyKeystring | This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |
| Group | Version | Kind |
|---|---|---|
core | v1 | PodAntiAffinity |
Pod anti affinity is a group of inter pod anti affinity scheduling rules.
+| Field | Description |
|---|---|
preferredDuringSchedulingIgnoredDuringExecutionWeightedPodAffinityTerm array | The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. |
requiredDuringSchedulingIgnoredDuringExecutionPodAffinityTerm array | If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. |
| Group | Version | Kind |
|---|---|---|
core | v1 | PodCondition |
PodCondition contains details for the current condition of this pod.
+| Field | Description |
|---|---|
lastProbeTimeTime | Last time we probed the condition. |
lastTransitionTimeTime | Last time the condition transitioned from one status to another. |
messagestring | Human-readable message indicating details about last transition. |
reasonstring | Unique, one-word, CamelCase reason for the condition's last transition. |
statusstring | Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions |
typestring | Type is the type of the condition. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions |
| Group | Version | Kind |
|---|---|---|
core | v1 | PodDNSConfig |
PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.
+| Field | Description |
|---|---|
nameserversstring array | A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed. |
optionsPodDNSConfigOption array | A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy. |
searchesstring array | A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed. |
| Group | Version | Kind |
|---|---|---|
core | v1 | PodDNSConfigOption |
PodDNSConfigOption defines DNS resolver options of a pod.
+| Field | Description |
|---|---|
namestring | Required. |
valuestring |
| Group | Version | Kind |
|---|---|---|
core | v1 | PodReadinessGate |
PodReadinessGate contains the reference to a pod condition
+| Field | Description |
|---|---|
conditionTypestring | ConditionType refers to a condition in the pod's condition list with matching type. |
| Group | Version | Kind |
|---|---|---|
core | v1 | PodSecurityContext |
PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.
+| Field | Description |
|---|---|
fsGroupinteger | A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- If unset, the Kubelet will not modify the ownership and permissions of any volume. |
runAsGroupinteger | The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. |
runAsNonRootboolean | Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
runAsUserinteger | The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. |
seLinuxOptionsSELinuxOptions | The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. |
supplementalGroupsinteger array | A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container. |
sysctlsSysctl array | Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta2 | PodsMetricSource |
PodsMetricSource indicates how to scale on a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.
+| Field | Description |
|---|---|
metricMetricIdentifier | metric identifies the target metric by name and selector |
targetMetricTarget | target specifies the target value for the given metric |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta2 | PodsMetricStatus |
PodsMetricStatus indicates the current value of a metric describing each pod in the current scale target (for example, transactions-processed-per-second).
+| Field | Description |
|---|---|
currentMetricValueStatus | current contains the current value for the given metric |
metricMetricIdentifier | metric identifies the target metric by name and selector |
| Group | Version | Kind |
|---|---|---|
auditregistration.k8s.io | v1alpha1 | Policy |
Policy defines the configuration of how audit events are logged
+| Field | Description |
|---|---|
levelstring | The Level that all requests are recorded at. available options: None, Metadata, Request, RequestResponse required |
stagesstring array | Stages is a list of stages for which events are created. |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1 | PolicyRule |
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.
+ +| Field | Description |
|---|---|
apiGroupsstring 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. |
nonResourceURLsstring 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. |
resourceNamesstring array | ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. |
resourcesstring array | Resources is a list of resources this rule applies to. ResourceAll represents all resources. |
verbsstring array | Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds. |
| Group | Version | Kind |
|---|---|---|
core | v1 | PortworxVolumeSource |
PortworxVolumeSource represents a Portworx volume resource.
+| Field | Description |
|---|---|
fsTypestring | FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified. |
readOnlyboolean | Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
volumeIDstring | VolumeID uniquely identifies a Portworx volume |
| Group | Version | Kind |
|---|---|---|
meta | v1 | Preconditions |
Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.
+| Field | Description |
|---|---|
uidstring | Specifies the target UID. |
| Group | Version | Kind |
|---|---|---|
core | v1 | PreferredSchedulingTerm |
An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).
+| Field | Description |
|---|---|
preferenceNodeSelectorTerm | A node selector term, associated with the corresponding weight. |
weightinteger | Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. |
| Group | Version | Kind |
|---|---|---|
core | v1 | Probe |
Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
+| Field | Description |
|---|---|
execExecAction | One and only one of the following should be specified. Exec specifies the action to take. |
failureThresholdinteger | Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
httpGetHTTPGetAction | HTTPGet specifies the http request to perform. |
initialDelaySecondsinteger | Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
periodSecondsinteger | How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
successThresholdinteger | Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1. |
tcpSocketTCPSocketAction | TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported |
timeoutSecondsinteger | Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| Group | Version | Kind |
|---|---|---|
core | v1 | ProjectedVolumeSource |
Represents a projected volume source
+| Field | Description |
|---|---|
defaultModeinteger | Mode bits to use on created files by default. Must be a value between 0 and 0777. 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. |
sourcesVolumeProjection array | list of volume projections |
| Group | Version | Kind |
|---|---|---|
core | resource | Quantity |
Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and Int64() accessors. + +The serialization format is: + +<quantity> ::= <signedNumber><suffix> + (Note that <suffix> may be empty, from the "" case in <decimalSI>.) +<digit> ::= 0 | 1 | ... | 9 <digits> ::= <digit> | <digit><digits> <number> ::= <digits> | <digits>.<digits> | <digits>. | .<digits> <sign> ::= "+" | "-" <signedNumber> ::= <number> | <sign><number> <suffix> ::= <binarySI> | <decimalExponent> | <decimalSI> <binarySI> ::= Ki | Mi | Gi | Ti | Pi | Ei + (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) +<decimalSI> ::= m | "" | k | M | G | T | P | E + (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) +<decimalExponent> ::= "e" <signedNumber> | "E" <signedNumber> + +No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. + +When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. + +Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: + a. No precision is lost + b. No fractional digits will be emitted + c. The exponent (or suffix) is as large as possible. +The sign will be omitted unless the number is negative. + +Examples: + 1.5 will be serialized as "1500m" + 1.5Gi will be serialized as "1536Mi" + +Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. + +Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) + +This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.
+| Field | Description |
|---|
| Group | Version | Kind |
|---|---|---|
core | v1 | QuobyteVolumeSource |
Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.
+| Field | Description |
|---|---|
groupstring | Group to map volume access to Default is no group |
readOnlyboolean | ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false. |
registrystring | Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes |
userstring | User to map volume access to Defaults to serivceaccount user |
volumestring | Volume is a string that references an already created Quobyte volume by name. |
| Group | Version | Kind |
|---|---|---|
core | v1 | RBDPersistentVolumeSource |
Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.
+| Field | Description |
|---|---|
fsTypestring | 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#rbd |
imagestring | The rados image name. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it |
keyringstring | Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it |
monitorsstring array | A collection of Ceph monitors. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it |
poolstring | The rados pool name. Default is rbd. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it |
readOnlyboolean | ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it |
secretRefSecretReference | SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it |
userstring | The rados user name. Default is admin. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it |
| Group | Version | Kind |
|---|---|---|
core | v1 | RBDVolumeSource |
Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.
+| Field | Description |
|---|---|
fsTypestring | 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#rbd |
imagestring | The rados image name. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it |
keyringstring | Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it |
monitorsstring array | A collection of Ceph monitors. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it |
poolstring | The rados pool name. Default is rbd. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it |
readOnlyboolean | ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it |
secretRefLocalObjectReference | SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it |
userstring | The rados user name. Default is admin. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it |
| Group | Version | Kind |
|---|---|---|
apps | v1 | ReplicaSetCondition |
ReplicaSetCondition describes the state of a replica set at a certain point.
+ +| Field | Description |
|---|---|
lastTransitionTimeTime | The last time the condition transitioned from one status to another. |
messagestring | A human readable message indicating details about the transition. |
reasonstring | The reason for the condition's last transition. |
statusstring | Status of the condition, one of True, False, Unknown. |
typestring | Type of replica set condition. |
| Group | Version | Kind |
|---|---|---|
core | v1 | ReplicationControllerCondition |
ReplicationControllerCondition describes the state of a replication controller at a certain point.
+| Field | Description |
|---|---|
lastTransitionTimeTime | The last time the condition transitioned from one status to another. |
messagestring | A human readable message indicating details about the transition. |
reasonstring | The reason for the condition's last transition. |
statusstring | Status of the condition, one of True, False, Unknown. |
typestring | Type of replication controller condition. |
| Group | Version | Kind |
|---|---|---|
authorization.k8s.io | v1 | ResourceAttributes |
ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface
+| Field | Description |
|---|---|
groupstring | Group is the API Group of the Resource. "*" means all. |
namestring | Name is the name of the resource being requested for a "get" or deleted for a "delete". "" (empty) means all. |
namespacestring | 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 |
resourcestring | Resource is one of the existing resource types. "*" means all. |
subresourcestring | Subresource is one of the existing resource types. "" means none. |
verbstring | Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all. |
versionstring | Version is the API Version of the Resource. "*" means all. |
| Group | Version | Kind |
|---|---|---|
core | v1 | ResourceFieldSelector |
ResourceFieldSelector represents container resources (cpu, memory) and their output format
+| Field | Description |
|---|---|
containerNamestring | Container name: required for volumes, optional for env vars |
divisorQuantity | Specifies the output format of the exposed resources, defaults to "1" |
resourcestring | Required: resource to select |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta2 | ResourceMetricSource |
ResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). The values will be averaged together before being compared to the target. Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. Only one "target" type should be set.
+| Field | Description |
|---|---|
namestring | name is the name of the resource in question. |
targetMetricTarget | target specifies the target value for the given metric |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta2 | ResourceMetricStatus |
ResourceMetricStatus indicates the current value of a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
+| Field | Description |
|---|---|
currentMetricValueStatus | current contains the current value for the given metric |
namestring | Name is the name of the resource in question. |
| Group | Version | Kind |
|---|---|---|
core | v1 | ResourceRequirements |
ResourceRequirements describes the compute resource requirements.
+| Field | Description |
|---|---|
limitsobject | Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |
requestsobject | Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |
| Group | Version | Kind |
|---|---|---|
authorization.k8s.io | v1 | ResourceRule |
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.
+| Field | Description |
|---|---|
apiGroupsstring 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. |
resourceNamesstring array | ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. "*" means all. |
resourcesstring 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. |
verbsstring array | Verb is a list of kubernetes resource API verbs, like: get, list, watch, create, update, delete, proxy. "*" means all. |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1 | RoleRef |
RoleRef contains information that points to the role being used
+ +| Field | Description |
|---|---|
apiGroupstring | APIGroup is the group for the resource being referenced |
kindstring | Kind is the type of resource being referenced |
namestring | Name is the name of resource being referenced |
| Group | Version | Kind |
|---|---|---|
apps | v1beta1 | RollbackConfig |
DEPRECATED.
+| Field | Description |
|---|---|
revisioninteger | The revision to rollback to. If set to 0, rollback to the last revision. |
| Group | Version | Kind |
|---|---|---|
apps | v1 | RollingUpdateStatefulSetStrategy |
RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.
+ +| Field | Description |
|---|---|
partitioninteger | Partition indicates the ordinal at which the StatefulSet should be partitioned. Default value is 0. |
| Group | Version | Kind |
|---|---|---|
admissionregistration.k8s.io | v1alpha1 | Rule |
Rule is a tuple of APIGroups, APIVersion, and Resources.It is recommended to make sure that all the tuple expansions are valid.
+| Field | Description |
|---|---|
apiGroupsstring array | APIGroups is the API groups the resources belong to. '\*' is all groups. If '\*' is present, the length of the slice must be one. Required. |
apiVersionsstring array | APIVersions is the API versions the resources belong to. '\*' is all versions. If '\*' is present, the length of the slice must be one. Required. |
resourcesstring array | Resources is a list of resources this rule applies to. For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '\*' means all resources, but not subresources. 'pods/\*' means all subresources of pods. '\*/scale' means all scale subresources. '\*/\*' means all resources and their subresources. If wildcard is present, the validation rule will ensure resources do not overlap with each other. Depending on the enclosing object, subresources might not be allowed. Required. |
| Group | Version | Kind |
|---|---|---|
admissionregistration.k8s.io | v1beta1 | RuleWithOperations |
RuleWithOperations is a tuple of Operations and Resources. It is recommended to make sure that all the tuple expansions are valid.
+| Field | Description |
|---|---|
apiGroupsstring array | APIGroups is the API groups the resources belong to. '\*' is all groups. If '\*' is present, the length of the slice must be one. Required. |
apiVersionsstring array | APIVersions is the API versions the resources belong to. '\*' is all versions. If '\*' is present, the length of the slice must be one. Required. |
operationsstring array | Operations is the operations the admission hook cares about - CREATE, UPDATE, or * for all operations. If '\*' is present, the length of the slice must be one. Required. |
resourcesstring array | Resources is a list of resources this rule applies to. For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '\*' means all resources, but not subresources. 'pods/\*' means all subresources of pods. '\*/scale' means all scale subresources. '\*/\*' means all resources and their subresources. If wildcard is present, the validation rule will ensure resources do not overlap with each other. Depending on the enclosing object, subresources might not be allowed. Required. |
| Group | Version | Kind |
|---|---|---|
extensions | v1beta1 | RunAsGroupStrategyOptions |
RunAsGroupStrategyOptions defines the strategy type and any options used to create the strategy. Deprecated: use RunAsGroupStrategyOptions from policy API Group instead.
+| Field | Description |
|---|---|
rangesIDRange array | ranges are the allowed ranges of gids that may be used. If you would like to force a single gid then supply a single range with the same start and end. Required for MustRunAs. |
rulestring | rule is the strategy that will dictate the allowable RunAsGroup values that may be set. |
| Group | Version | Kind |
|---|---|---|
extensions | v1beta1 | RunAsUserStrategyOptions |
RunAsUserStrategyOptions defines the strategy type and any options used to create the strategy. Deprecated: use RunAsUserStrategyOptions from policy API Group instead.
+| Field | Description |
|---|---|
rangesIDRange array | ranges are the allowed ranges of uids that may be used. If you would like to force a single uid then supply a single range with the same start and end. Required for MustRunAs. |
rulestring | rule is the strategy that will dictate the allowable RunAsUser values that may be set. |
| Group | Version | Kind |
|---|---|---|
core | v1 | SELinuxOptions |
SELinuxOptions are the labels to be applied to the container
+| Field | Description |
|---|---|
levelstring | Level is SELinux level label that applies to the container. |
rolestring | Role is a SELinux role label that applies to the container. |
typestring | Type is a SELinux type label that applies to the container. |
userstring | User is a SELinux user label that applies to the container. |
| Group | Version | Kind |
|---|---|---|
extensions | v1beta1 | SELinuxStrategyOptions |
SELinuxStrategyOptions defines the strategy type and any options used to create the strategy. Deprecated: use SELinuxStrategyOptions from policy API Group instead.
+| Field | Description |
|---|---|
rulestring | rule is the strategy that will dictate the allowable labels that may be set. |
seLinuxOptionsSELinuxOptions | seLinuxOptions required to run as; required for MustRunAs More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ |
| Group | Version | Kind |
|---|---|---|
autoscaling | v1 | Scale |
Scale represents a scaling request for a resource.
+ +| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata. |
specScaleSpec | defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. |
statusScaleStatus | current status of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. Read-only. |
| Group | Version | Kind |
|---|---|---|
core | v1 | ScaleIOPersistentVolumeSource |
ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume
+| Field | Description |
|---|---|
fsTypestring | Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs" |
gatewaystring | The host address of the ScaleIO API Gateway. |
protectionDomainstring | The name of the ScaleIO Protection Domain for the configured storage. |
readOnlyboolean | Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
secretRefSecretReference | SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail. |
sslEnabledboolean | Flag to enable/disable SSL communication with Gateway, default false |
storageModestring | Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. |
storagePoolstring | The ScaleIO Storage Pool associated with the protection domain. |
systemstring | The name of the storage system as configured in ScaleIO. |
volumeNamestring | The name of a volume already created in the ScaleIO system that is associated with this volume source. |
| Group | Version | Kind |
|---|---|---|
core | v1 | ScaleIOVolumeSource |
ScaleIOVolumeSource represents a persistent ScaleIO volume
+| Field | Description |
|---|---|
fsTypestring | Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs". |
gatewaystring | The host address of the ScaleIO API Gateway. |
protectionDomainstring | The name of the ScaleIO Protection Domain for the configured storage. |
readOnlyboolean | Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
secretRefLocalObjectReference | SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail. |
sslEnabledboolean | Flag to enable/disable SSL communication with Gateway, default false |
storageModestring | Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. |
storagePoolstring | The ScaleIO Storage Pool associated with the protection domain. |
systemstring | The name of the storage system as configured in ScaleIO. |
volumeNamestring | The name of a volume already created in the ScaleIO system that is associated with this volume source. |
| Group | Version | Kind |
|---|---|---|
core | v1 | ScopeSelector |
A scope selector represents the AND of the selectors represented by the scoped-resource selector requirements.
+| Field | Description |
|---|---|
matchExpressionsScopedResourceSelectorRequirement array | A list of scope selector requirements by scope of the resources. |
| Group | Version | Kind |
|---|---|---|
core | v1 | ScopedResourceSelectorRequirement |
A scoped-resource selector requirement is a selector that contains values, a scope name, and an operator that relates the scope name and values.
+| Field | Description |
|---|---|
operatorstring | Represents a scope's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. |
scopeNamestring | The name of the scope that the selector applies to. |
valuesstring array | An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
| Group | Version | Kind |
|---|---|---|
core | v1 | SecretEnvSource |
SecretEnvSource selects a Secret to populate the environment variables with. + +The contents of the target Secret's Data field will represent the key-value pairs as environment variables.
+| Field | Description |
|---|---|
namestring | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optionalboolean | Specify whether the Secret must be defined |
| Group | Version | Kind |
|---|---|---|
core | v1 | SecretKeySelector |
SecretKeySelector selects a key of a Secret.
+| Field | Description |
|---|---|
keystring | The key of the secret to select from. Must be a valid secret key. |
namestring | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optionalboolean | Specify whether the Secret or it's key must be defined |
| Group | Version | Kind |
|---|---|---|
core | v1 | SecretProjection |
Adapts a secret into a projected volume. + +The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode.
+| Field | Description |
|---|---|
itemsKeyToPath array | If unspecified, each key-value pair in the Data field of the referenced Secret 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 Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. |
namestring | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optionalboolean | Specify whether the Secret or its key must be defined |
| Group | Version | Kind |
|---|---|---|
core | v1 | SecretReference |
SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace
+| Field | Description |
|---|---|
namestring | Name is unique within a namespace to reference a secret resource. |
namespacestring | Namespace defines the space within which the secret name must be unique. |
| Group | Version | Kind |
|---|---|---|
core | v1 | SecretVolumeSource |
Adapts a Secret into a volume. + +The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.
+| Field | Description |
|---|---|
defaultModeinteger | 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. |
itemsKeyToPath array | If unspecified, each key-value pair in the Data field of the referenced Secret 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 Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. |
optionalboolean | Specify whether the Secret or it's keys must be defined |
secretNamestring | Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret |
| Group | Version | Kind |
|---|---|---|
core | v1 | SecurityContext |
SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.
+| Field | Description |
|---|---|
allowPrivilegeEscalationboolean | AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN |
capabilitiesCapabilities | The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. |
privilegedboolean | Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. |
procMountstring | procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. |
readOnlyRootFilesystemboolean | Whether this container has a read-only root filesystem. Default is false. |
runAsGroupinteger | The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
runAsNonRootboolean | Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
runAsUserinteger | The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
seLinuxOptionsSELinuxOptions | The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
| Group | Version | Kind |
|---|---|---|
meta | v1 | ServerAddressByClientCIDR |
ServerAddressByClientCIDR helps the client to determine the server address that they should use, depending on the clientCIDR that they match.
+| Field | Description |
|---|---|
clientCIDRstring | The CIDR with which clients can match their IP to figure out the server address that they should use. |
serverAddressstring | Address of this server, suitable for a client that matches the above CIDR. This can be a hostname, hostname:port, IP or IP:port. |
| Group | Version | Kind |
|---|---|---|
core | v1 | ServiceAccountTokenProjection |
ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise).
+| Field | Description |
|---|---|
audiencestring | Audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. |
expirationSecondsinteger | ExpirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. |
pathstring | Path is the path relative to the mount point of the file to project the token into. |
| Group | Version | Kind |
|---|---|---|
core | v1 | ServicePort |
ServicePort contains information on service's port.
+| Field | Description |
|---|---|
namestring | The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. This maps to the 'Name' field in EndpointPort objects. Optional if only one ServicePort is defined on this service. |
nodePortinteger | The port on each node on which this service is exposed when type=NodePort or LoadBalancer. Usually assigned by the system. If specified, it will be allocated to the service if unused or else creation of the service will fail. Default is to auto-allocate a port if the ServiceType of this Service requires one. More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport |
portinteger | The port that will be exposed by this service. |
protocolstring | The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP. |
targetPort | Number or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod's container ports. If this is not specified, the value of the 'port' field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the 'port' field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service |
| Group | Version | Kind |
|---|---|---|
apiregistration.k8s.io | v1 | ServiceReference |
ServiceReference holds a reference to Service.legacy.k8s.io
+ +| Field | Description |
|---|---|
namestring | Name is the name of the service |
namespacestring | Namespace is the namespace of the service |
| Group | Version | Kind |
|---|---|---|
core | v1 | SessionAffinityConfig |
SessionAffinityConfig represents the configurations of session affinity.
+| Field | Description |
|---|---|
clientIPClientIPConfig | clientIP contains the configurations of Client IP based session affinity. |
| Group | Version | Kind |
|---|---|---|
apps | v1 | StatefulSetCondition |
StatefulSetCondition describes the state of a statefulset at a certain point.
+ +| Field | Description |
|---|---|
lastTransitionTimeTime | Last time the condition transitioned from one status to another. |
messagestring | A human readable message indicating details about the transition. |
reasonstring | The reason for the condition's last transition. |
statusstring | Status of the condition, one of True, False, Unknown. |
typestring | Type of statefulset condition. |
| Group | Version | Kind |
|---|---|---|
apps | v1 | 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.
+ +| Field | Description |
|---|---|
rollingUpdateRollingUpdateStatefulSetStrategy | RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType. |
typestring | Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate. |
| Group | Version | Kind |
|---|---|---|
meta | v1 | Status |
Status is a return value for calls that don't return other objects.
+| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
codeinteger | Suggested HTTP return code for this status, 0 if not set. |
detailsStatusDetails | Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
messagestring | A human-readable description of the status of this operation. |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
reasonstring | A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it. |
statusstring | Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
| Group | Version | Kind |
|---|---|---|
meta | v1 | StatusCause |
StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.
+| Field | Description |
|---|---|
fieldstring | The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional. Examples: "name" - the field "name" on the current resource "items[0].name" - the field "name" on the first array entry in "items" |
messagestring | A human-readable description of the cause of the error. This field may be presented as-is to a reader. |
reasonstring | A machine-readable description of the cause of the error. If this value is empty there is no information available. |
| Group | Version | Kind |
|---|---|---|
meta | v1 | StatusDetails |
StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.
+| Field | Description |
|---|---|
causesStatusCause array | The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes. |
groupstring | The group attribute of the resource associated with the status StatusReason. |
kindstring | The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
namestring | The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described). |
retryAfterSecondsinteger | If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action. |
uidstring | UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| Group | Version | Kind |
|---|---|---|
core | v1 | StorageOSPersistentVolumeSource |
Represents a StorageOS persistent volume resource.
+| Field | Description |
|---|---|
fsTypestring | 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. |
readOnlyboolean | Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
secretRefObjectReference | SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted. |
volumeNamestring | VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace. |
volumeNamespacestring | VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. |
| Group | Version | Kind |
|---|---|---|
core | v1 | StorageOSVolumeSource |
Represents a StorageOS persistent volume resource.
+| Field | Description |
|---|---|
fsTypestring | 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. |
readOnlyboolean | Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
secretRefLocalObjectReference | SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted. |
volumeNamestring | VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace. |
volumeNamespacestring | VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1 | Subject |
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 |
|---|---|
apiGroupstring | 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. |
kindstring | 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. |
namestring | Name of the object being referenced. |
namespacestring | 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. |
| Group | Version | Kind |
|---|---|---|
authorization.k8s.io | v1 | SubjectRulesReviewStatus |
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.
+| Field | Description |
|---|---|
evaluationErrorstring | 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. |
incompleteboolean | 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. |
nonResourceRulesNonResourceRule array | 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. |
resourceRulesResourceRule array | 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. |
| Group | Version | Kind |
|---|---|---|
extensions | v1beta1 | SupplementalGroupsStrategyOptions |
SupplementalGroupsStrategyOptions defines the strategy type and options used to create the strategy. Deprecated: use SupplementalGroupsStrategyOptions from policy API Group instead.
+| Field | Description |
|---|---|
rangesIDRange array | 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. Required for MustRunAs. |
rulestring | rule is the strategy that will dictate what supplemental groups is used in the SecurityContext. |
| Group | Version | Kind |
|---|---|---|
core | v1 | Sysctl |
Sysctl defines a kernel parameter to be set
+| Field | Description |
|---|---|
namestring | Name of a property to set |
valuestring | Value of a property to set |
| Group | Version | Kind |
|---|---|---|
core | v1 | TCPSocketAction |
TCPSocketAction describes an action based on opening a socket
+| Field | Description |
|---|---|
hoststring | Optional: Host name to connect to, defaults to the pod IP. |
port | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
| Group | Version | Kind |
|---|---|---|
core | v1 | Taint |
The node this Taint is attached to has the "effect" on any pod that does not tolerate the Taint.
+| Field | Description |
|---|---|
effectstring | Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute. |
keystring | Required. The taint key to be applied to a node. |
timeAddedTime | TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints. |
valuestring | Required. The taint value corresponding to the taint key. |
| Group | Version | Kind |
|---|---|---|
meta | v1 | Time |
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
+| Field | Description |
|---|
| Group | Version | Kind |
|---|---|---|
core | v1 | Toleration |
The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
+| Field | Description |
|---|---|
effectstring | Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. |
keystring | Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. |
operatorstring | Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. |
tolerationSecondsinteger | TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. |
valuestring | Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. |
| Group | Version | Kind |
|---|---|---|
core | v1 | TopologySelectorLabelRequirement |
A topology selector requirement is a selector that matches given label. This is an alpha feature and may change in the future.
+| Field | Description |
|---|---|
keystring | The label key that the selector applies to. |
valuesstring array | An array of string values. One value must match the label to be selected. Each entry in Values is ORed. |
| Group | Version | Kind |
|---|---|---|
core | v1 | TopologySelectorTerm |
A topology selector term represents the result of label queries. A null or empty topology selector term matches no objects. The requirements of them are ANDed. It provides a subset of functionality as NodeSelectorTerm. This is an alpha feature and may change in the future.
+| Field | Description |
|---|---|
matchLabelExpressionsTopologySelectorLabelRequirement array | A list of topology selector requirements by labels. |
| Group | Version | Kind |
|---|---|---|
core | v1 | TypedLocalObjectReference |
TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.
+| Field | Description |
|---|---|
apiGroupstring | APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. |
kindstring | Kind is the type of resource being referenced |
namestring | Name is the name of resource being referenced |
| Group | Version | Kind |
|---|---|---|
authentication.k8s.io | v1 | UserInfo |
UserInfo holds the information about the user needed to implement the user.Info interface.
+| Field | Description |
|---|---|
extraobject | Any additional information provided by the authenticator. |
groupsstring array | The names of groups this user is a part of. |
uidstring | 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. |
usernamestring | The name that uniquely identifies this user among all active users. |
| Group | Version | Kind |
|---|---|---|
storage.k8s.io | v1 | VolumeAttachment |
VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node. + +VolumeAttachment objects are non-namespaced.
+ +| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
specVolumeAttachmentSpec | Specification of the desired attach/detach volume behavior. Populated by the Kubernetes system. |
statusVolumeAttachmentStatus | Status of the VolumeAttachment request. Populated by the entity completing the attach or detach operation, i.e. the external-attacher. |
| Group | Version | Kind |
|---|---|---|
storage.k8s.io | v1 | VolumeAttachmentSource |
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.
+ +| Field | Description |
|---|---|
persistentVolumeNamestring | Name of the persistent volume to attach. |
| Group | Version | Kind |
|---|---|---|
core | v1 | VolumeDevice |
volumeDevice describes a mapping of a raw block device within a container.
+| Field | Description |
|---|---|
devicePathstring | devicePath is the path inside of the container that the device will be mapped to. |
namestring | name must match the name of a persistentVolumeClaim in the pod |
| Group | Version | Kind |
|---|---|---|
storage.k8s.io | v1 | VolumeError |
VolumeError captures an error encountered during a volume operation.
+ +| Field | Description |
|---|---|
messagestring | String detailing the error encountered during Attach or Detach operation. This string maybe logged, so it should not contain sensitive information. |
timeTime | Time the error was encountered. |
| Group | Version | Kind |
|---|---|---|
core | v1 | VolumeMount |
VolumeMount describes a mounting of a Volume within a container.
+| Field | Description |
|---|---|
mountPathstring | Path within the container at which the volume should be mounted. Must not contain ':'. |
mountPropagationstring | mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. |
namestring | This must match the Name of a Volume. |
readOnlyboolean | Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. |
subPathstring | Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). |
| Group | Version | Kind |
|---|---|---|
core | v1 | VolumeNodeAffinity |
VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from.
+| Field | Description |
|---|---|
requiredNodeSelector | Required specifies hard node constraints that must be met. |
| Group | Version | Kind |
|---|---|---|
core | v1 | VolumeProjection |
Projection that may be projected along with other supported volume types
+| Field | Description |
|---|---|
configMapConfigMapProjection | information about the configMap data to project |
downwardAPIDownwardAPIProjection | information about the downwardAPI data to project |
secretSecretProjection | information about the secret data to project |
serviceAccountTokenServiceAccountTokenProjection | information about the serviceAccountToken data to project |
| Group | Version | Kind |
|---|---|---|
core | v1 | VsphereVirtualDiskVolumeSource |
Represents a vSphere volume resource.
+| Field | Description |
|---|---|
fsTypestring | 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. |
storagePolicyIDstring | Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. |
storagePolicyNamestring | Storage Policy Based Management (SPBM) profile name. |
volumePathstring | Path that identifies vSphere volume vmdk |
| Group | Version | Kind |
|---|---|---|
meta | v1 | WatchEvent |
Event represents a single event to a watched resource.
+| Field | Description |
|---|---|
object | Object is: * If Type is Added or Modified: the new state of the object. * If Type is Deleted: the state of the object immediately before deletion. * If Type is Error: *Status is recommended; other types may make sense depending on context. |
typestring |
| Group | Version | Kind |
|---|---|---|
admissionregistration.k8s.io | v1beta1 | Webhook |
Webhook describes an admission webhook and the resources and operations it applies to.
+| Field | Description |
|---|---|
clientConfigWebhookClientConfig | ClientConfig defines how to communicate with the hook. Required |
failurePolicystring | FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Ignore. |
namestring | 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. |
namespaceSelectorLabelSelector | 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 another cluster scoped resource, it never skips 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. |
rulesRuleWithOperations array | Rules describes what operations on what resources/subresources the webhook cares about. The webhook cares about an operation if it matches _any_ Rule. However, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks from putting the cluster in a state which cannot be recovered from without completely disabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects. |
sideEffectsstring | SideEffects states whether this webhookk has side effects. Acceptable values are: Unknown, None, Some, NoneOnDryRun Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission change and the side effects therefore need to be undone. Requests with the dryRun attribute will be auto-rejected if they match a webhook with sideEffects == Unknown or Some. Defaults to Unknown. |
| Group | Version | Kind |
|---|---|---|
admissionregistration.k8s.io | v1beta1 | WebhookClientConfig |
WebhookClientConfig contains the information to make a TLS connection with the webhook
+| Field | Description |
|---|---|
caBundlestring | `caBundle` is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. If unspecified, system trust roots on the apiserver are used. |
serviceServiceReference | `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`. Port 443 will be used if it is open, otherwise it is an error. |
urlstring | `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. |
| Group | Version | Kind |
|---|---|---|
auditregistration.k8s.io | v1alpha1 | WebhookThrottleConfig |
WebhookThrottleConfig holds the configuration for throttling events
+| Field | Description |
|---|---|
burstinteger | ThrottleBurst is the maximum number of events sent at the same moment default 15 QPS |
qpsinteger | ThrottleQPS maximum number of batches per second default 10 QPS |
| Group | Version | Kind |
|---|---|---|
core | v1 | WeightedPodAffinityTerm |
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
+| Field | Description |
|---|---|
podAffinityTermPodAffinityTerm | Required. A pod affinity term, associated with the corresponding weight. |
weightinteger | weight associated with matching the corresponding podAffinityTerm, in the range 1-100. |
This section contains older versions of resources shown above.
+| Group | Version | Kind |
|---|---|---|
apiregistration.k8s.io | v1beta1 | APIService |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | |
specAPIServiceSpec | Spec contains information for locating and communicating with a server |
statusAPIServiceStatus | Status contains derived information about an API server |
| Field | Description |
|---|---|
caBundlestring | CABundle is a PEM encoded CA bundle which will be used to validate an API server's serving certificate. If unspecified, system trust roots on the apiserver are used. |
groupstring | Group is the API group name this server hosts |
groupPriorityMinimuminteger | 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 |
insecureSkipTLSVerifyboolean | InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. This is strongly discouraged. You should use the CABundle instead. |
serviceServiceReference | 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. |
versionstring | Version is the API version this server hosts. For example, "v1" |
versionPriorityinteger | 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). Since it's inside of a group, the number can be small, probably in the 10s. In case of equal version priorities, the version string will be used to compute the order inside a group. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10. |
| Field | Description |
|---|---|
conditionsAPIServiceCondition array patch strategy: merge patch merge key: type | Current service state of apiService. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsAPIService array | |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta |
create an APIService
+POST /apis/apiregistration.k8s.io/v1beta1/apiservices
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyAPIService |
| Code | Description |
|---|---|
| 200 APIService | OK |
| 201 APIService | Created |
| 202 APIService | Accepted |
partially update the specified APIService
+PATCH /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}
+| Parameter | Description |
|---|---|
name | name of the APIService |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 APIService | OK |
replace the specified APIService
+PUT /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}
+| Parameter | Description |
|---|---|
name | name of the APIService |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyAPIService |
| Code | Description |
|---|---|
| 200 APIService | OK |
| 201 APIService | Created |
delete an APIService
+DELETE /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}
+| Parameter | Description |
|---|---|
name | name of the APIService |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of APIService
+DELETE /apis/apiregistration.k8s.io/v1beta1/apiservices
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified APIService
+GET /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}
+| Parameter | Description |
|---|---|
name | name of the APIService |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 APIService | OK |
list or watch objects of kind APIService
+GET /apis/apiregistration.k8s.io/v1beta1/apiservices
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 APIServiceList | OK |
watch changes to an object of kind APIService. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/apiregistration.k8s.io/v1beta1/watch/apiservices/{name}
+| Parameter | Description |
|---|---|
name | name of the APIService |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of APIService. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/apiregistration.k8s.io/v1beta1/watch/apiservices
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified APIService
+PATCH /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}/status
+| Parameter | Description |
|---|---|
name | name of the APIService |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 APIService | OK |
read status of the specified APIService
+GET /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}/status
+| Parameter | Description |
|---|---|
name | name of the APIService |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 APIService | OK |
replace status of the specified APIService
+PUT /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}/status
+| Parameter | Description |
|---|---|
name | name of the APIService |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyAPIService |
| Code | Description |
|---|---|
| 200 APIService | OK |
| 201 APIService | Created |
| Group | Version | Kind |
|---|---|---|
apiregistration.k8s.io | v1beta1 | APIServiceCondition |
| Field | Description |
|---|---|
lastTransitionTimeTime | Last time the condition transitioned from one status to another. |
messagestring | Human-readable message indicating details about last transition. |
reasonstring | Unique, one-word, CamelCase reason for the condition's last transition. |
statusstring | Status is the status of the condition. Can be True, False, Unknown. |
typestring | Type is the type of the condition. |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1beta1 | AggregationRule |
| Field | Description |
|---|---|
clusterRoleSelectorsLabelSelector array | 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 |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1alpha1 | AggregationRule |
| Field | Description |
|---|---|
clusterRoleSelectorsLabelSelector array | 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 |
| Group | Version | Kind |
|---|---|---|
policy | v1beta1 | AllowedFlexVolume |
| Field | Description |
|---|---|
driverstring | driver is the name of the Flexvolume driver. |
| Group | Version | Kind |
|---|---|---|
policy | v1beta1 | AllowedHostPath |
| Field | Description |
|---|---|
pathPrefixstring | pathPrefix 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` |
readOnlyboolean | when set to true, will allow host volumes matching the pathPrefix only if all volume mounts are readOnly. |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1beta1 | ClusterRole |
| Field | Description |
|---|---|
aggregationRuleAggregationRule | 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. |
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. |
rulesPolicyRule array | Rules holds all the PolicyRules for this ClusterRole |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsClusterRole array | Items is a list of ClusterRoles |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard object's metadata. |
create a ClusterRole
+POST /apis/rbac.authorization.k8s.io/v1beta1/clusterroles
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyClusterRole |
| Code | Description |
|---|---|
| 200 ClusterRole | OK |
| 201 ClusterRole | Created |
| 202 ClusterRole | Accepted |
partially update the specified ClusterRole
+PATCH /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name}
+| Parameter | Description |
|---|---|
name | name of the ClusterRole |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ClusterRole | OK |
replace the specified ClusterRole
+PUT /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name}
+| Parameter | Description |
|---|---|
name | name of the ClusterRole |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyClusterRole |
| Code | Description |
|---|---|
| 201 ClusterRole | Created |
| 200 ClusterRole | OK |
delete a ClusterRole
+DELETE /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name}
+| Parameter | Description |
|---|---|
name | name of the ClusterRole |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of ClusterRole
+DELETE /apis/rbac.authorization.k8s.io/v1beta1/clusterroles
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified ClusterRole
+GET /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name}
+| Parameter | Description |
|---|---|
name | name of the ClusterRole |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 ClusterRole | OK |
list or watch objects of kind ClusterRole
+GET /apis/rbac.authorization.k8s.io/v1beta1/clusterroles
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 ClusterRoleList | OK |
watch changes to an object of kind ClusterRole. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/rbac.authorization.k8s.io/v1beta1/watch/clusterroles/{name}
+| Parameter | Description |
|---|---|
name | name of the ClusterRole |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ClusterRole. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/rbac.authorization.k8s.io/v1beta1/watch/clusterroles
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1alpha1 | ClusterRole |
| Field | Description |
|---|---|
aggregationRuleAggregationRule | 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. |
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. |
rulesPolicyRule array | Rules holds all the PolicyRules for this ClusterRole |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsClusterRole array | Items is a list of ClusterRoles |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard object's metadata. |
create a ClusterRole
+POST /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyClusterRole |
| Code | Description |
|---|---|
| 200 ClusterRole | OK |
| 201 ClusterRole | Created |
| 202 ClusterRole | Accepted |
partially update the specified ClusterRole
+PATCH /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}
+| Parameter | Description |
|---|---|
name | name of the ClusterRole |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ClusterRole | OK |
replace the specified ClusterRole
+PUT /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}
+| Parameter | Description |
|---|---|
name | name of the ClusterRole |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyClusterRole |
| Code | Description |
|---|---|
| 200 ClusterRole | OK |
| 201 ClusterRole | Created |
delete a ClusterRole
+DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}
+| Parameter | Description |
|---|---|
name | name of the ClusterRole |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 202 Status | Accepted |
| 200 Status | OK |
delete collection of ClusterRole
+DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified ClusterRole
+GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}
+| Parameter | Description |
|---|---|
name | name of the ClusterRole |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 ClusterRole | OK |
list or watch objects of kind ClusterRole
+GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 ClusterRoleList | OK |
watch changes to an object of kind ClusterRole. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterroles/{name}
+| Parameter | Description |
|---|---|
name | name of the ClusterRole |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ClusterRole. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterroles
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1beta1 | ClusterRoleBinding |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. |
roleRefRoleRef | RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. |
subjectsSubject array | Subjects holds references to the objects the role applies to. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsClusterRoleBinding array | Items is a list of ClusterRoleBindings |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard object's metadata. |
create a ClusterRoleBinding
+POST /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyClusterRoleBinding |
| Code | Description |
|---|---|
| 202 ClusterRoleBinding | Accepted |
| 200 ClusterRoleBinding | OK |
| 201 ClusterRoleBinding | Created |
partially update the specified ClusterRoleBinding
+PATCH /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name}
+| Parameter | Description |
|---|---|
name | name of the ClusterRoleBinding |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ClusterRoleBinding | OK |
replace the specified ClusterRoleBinding
+PUT /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name}
+| Parameter | Description |
|---|---|
name | name of the ClusterRoleBinding |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyClusterRoleBinding |
| Code | Description |
|---|---|
| 200 ClusterRoleBinding | OK |
| 201 ClusterRoleBinding | Created |
delete a ClusterRoleBinding
+DELETE /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name}
+| Parameter | Description |
|---|---|
name | name of the ClusterRoleBinding |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of ClusterRoleBinding
+DELETE /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified ClusterRoleBinding
+GET /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name}
+| Parameter | Description |
|---|---|
name | name of the ClusterRoleBinding |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 ClusterRoleBinding | OK |
list or watch objects of kind ClusterRoleBinding
+GET /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 ClusterRoleBindingList | OK |
watch changes to an object of kind ClusterRoleBinding. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/rbac.authorization.k8s.io/v1beta1/watch/clusterrolebindings/{name}
+| Parameter | Description |
|---|---|
name | name of the ClusterRoleBinding |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ClusterRoleBinding. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/rbac.authorization.k8s.io/v1beta1/watch/clusterrolebindings
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1alpha1 | ClusterRoleBinding |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. |
roleRefRoleRef | RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. |
subjectsSubject array | Subjects holds references to the objects the role applies to. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsClusterRoleBinding array | Items is a list of ClusterRoleBindings |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard object's metadata. |
create a ClusterRoleBinding
+POST /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyClusterRoleBinding |
| Code | Description |
|---|---|
| 201 ClusterRoleBinding | Created |
| 202 ClusterRoleBinding | Accepted |
| 200 ClusterRoleBinding | OK |
partially update the specified ClusterRoleBinding
+PATCH /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}
+| Parameter | Description |
|---|---|
name | name of the ClusterRoleBinding |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ClusterRoleBinding | OK |
replace the specified ClusterRoleBinding
+PUT /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}
+| Parameter | Description |
|---|---|
name | name of the ClusterRoleBinding |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyClusterRoleBinding |
| Code | Description |
|---|---|
| 200 ClusterRoleBinding | OK |
| 201 ClusterRoleBinding | Created |
delete a ClusterRoleBinding
+DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}
+| Parameter | Description |
|---|---|
name | name of the ClusterRoleBinding |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of ClusterRoleBinding
+DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified ClusterRoleBinding
+GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}
+| Parameter | Description |
|---|---|
name | name of the ClusterRoleBinding |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 ClusterRoleBinding | OK |
list or watch objects of kind ClusterRoleBinding
+GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 ClusterRoleBindingList | OK |
watch changes to an object of kind ClusterRoleBinding. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterrolebindings/{name}
+| Parameter | Description |
|---|---|
name | name of the ClusterRoleBinding |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ClusterRoleBinding. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterrolebindings
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
apps | v1beta2 | ControllerRevision |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
data | Data is the serialized representation of the state. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
revisioninteger | Revision indicates the revision of the state represented by Data. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsControllerRevision array | Items is the list of ControllerRevisions |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
create a ControllerRevision
+POST /apis/apps/v1beta2/namespaces/{namespace}/controllerrevisions
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyControllerRevision |
| Code | Description |
|---|---|
| 201 ControllerRevision | Created |
| 202 ControllerRevision | Accepted |
| 200 ControllerRevision | OK |
partially update the specified ControllerRevision
+PATCH /apis/apps/v1beta2/namespaces/{namespace}/controllerrevisions/{name}
+| Parameter | Description |
|---|---|
name | name of the ControllerRevision |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ControllerRevision | OK |
replace the specified ControllerRevision
+PUT /apis/apps/v1beta2/namespaces/{namespace}/controllerrevisions/{name}
+| Parameter | Description |
|---|---|
name | name of the ControllerRevision |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyControllerRevision |
| Code | Description |
|---|---|
| 201 ControllerRevision | Created |
| 200 ControllerRevision | OK |
delete a ControllerRevision
+DELETE /apis/apps/v1beta2/namespaces/{namespace}/controllerrevisions/{name}
+| Parameter | Description |
|---|---|
name | name of the ControllerRevision |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of ControllerRevision
+DELETE /apis/apps/v1beta2/namespaces/{namespace}/controllerrevisions
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified ControllerRevision
+GET /apis/apps/v1beta2/namespaces/{namespace}/controllerrevisions/{name}
+| Parameter | Description |
|---|---|
name | name of the ControllerRevision |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 ControllerRevision | OK |
list or watch objects of kind ControllerRevision
+GET /apis/apps/v1beta2/namespaces/{namespace}/controllerrevisions
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 ControllerRevisionList | OK |
list or watch objects of kind ControllerRevision
+GET /apis/apps/v1beta2/controllerrevisions
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 ControllerRevisionList | OK |
watch changes to an object of kind ControllerRevision. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/apps/v1beta2/watch/namespaces/{namespace}/controllerrevisions/{name}
+| Parameter | Description |
|---|---|
name | name of the ControllerRevision |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ControllerRevision. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/apps/v1beta2/watch/namespaces/{namespace}/controllerrevisions
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ControllerRevision. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/apps/v1beta2/watch/controllerrevisions
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
apps | v1beta1 | ControllerRevision |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
data | Data is the serialized representation of the state. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
revisioninteger | Revision indicates the revision of the state represented by Data. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsControllerRevision array | Items is the list of ControllerRevisions |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
create a ControllerRevision
+POST /apis/apps/v1beta1/namespaces/{namespace}/controllerrevisions
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyControllerRevision |
| Code | Description |
|---|---|
| 201 ControllerRevision | Created |
| 202 ControllerRevision | Accepted |
| 200 ControllerRevision | OK |
partially update the specified ControllerRevision
+PATCH /apis/apps/v1beta1/namespaces/{namespace}/controllerrevisions/{name}
+| Parameter | Description |
|---|---|
name | name of the ControllerRevision |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ControllerRevision | OK |
replace the specified ControllerRevision
+PUT /apis/apps/v1beta1/namespaces/{namespace}/controllerrevisions/{name}
+| Parameter | Description |
|---|---|
name | name of the ControllerRevision |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyControllerRevision |
| Code | Description |
|---|---|
| 200 ControllerRevision | OK |
| 201 ControllerRevision | Created |
delete a ControllerRevision
+DELETE /apis/apps/v1beta1/namespaces/{namespace}/controllerrevisions/{name}
+| Parameter | Description |
|---|---|
name | name of the ControllerRevision |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of ControllerRevision
+DELETE /apis/apps/v1beta1/namespaces/{namespace}/controllerrevisions
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified ControllerRevision
+GET /apis/apps/v1beta1/namespaces/{namespace}/controllerrevisions/{name}
+| Parameter | Description |
|---|---|
name | name of the ControllerRevision |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 ControllerRevision | OK |
list or watch objects of kind ControllerRevision
+GET /apis/apps/v1beta1/namespaces/{namespace}/controllerrevisions
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 ControllerRevisionList | OK |
list or watch objects of kind ControllerRevision
+GET /apis/apps/v1beta1/controllerrevisions
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 ControllerRevisionList | OK |
watch changes to an object of kind ControllerRevision. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/apps/v1beta1/watch/namespaces/{namespace}/controllerrevisions/{name}
+| Parameter | Description |
|---|---|
name | name of the ControllerRevision |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ControllerRevision. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/apps/v1beta1/watch/namespaces/{namespace}/controllerrevisions
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ControllerRevision. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/apps/v1beta1/watch/controllerrevisions
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
batch | v2alpha1 | CronJob |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
specCronJobSpec | Specification of the desired behavior of a cron job, including the schedule. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
statusCronJobStatus | Current status of a cron job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
concurrencyPolicystring | Specifies how to treat concurrent executions of a Job. Valid values are: - "Allow" (default): allows CronJobs to run concurrently; - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - "Replace": cancels currently running job and replaces it with a new one |
failedJobsHistoryLimitinteger | The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. |
jobTemplateJobTemplateSpec | Specifies the job that will be created when executing a CronJob. |
schedulestring | The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. |
startingDeadlineSecondsinteger | Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones. |
successfulJobsHistoryLimitinteger | The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. |
suspendboolean | This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false. |
| Field | Description |
|---|---|
activeObjectReference array | A list of pointers to currently running jobs. |
lastScheduleTimeTime | Information when was the last time the job was successfully scheduled. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsCronJob array | items is the list of CronJobs. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
create a CronJob
+POST /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyCronJob |
| Code | Description |
|---|---|
| 200 CronJob | OK |
| 201 CronJob | Created |
| 202 CronJob | Accepted |
partially update the specified CronJob
+PATCH /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}
+| Parameter | Description |
|---|---|
name | name of the CronJob |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 CronJob | OK |
replace the specified CronJob
+PUT /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}
+| Parameter | Description |
|---|---|
name | name of the CronJob |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyCronJob |
| Code | Description |
|---|---|
| 201 CronJob | Created |
| 200 CronJob | OK |
delete a CronJob
+DELETE /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}
+| Parameter | Description |
|---|---|
name | name of the CronJob |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of CronJob
+DELETE /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified CronJob
+GET /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}
+| Parameter | Description |
|---|---|
name | name of the CronJob |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 CronJob | OK |
list or watch objects of kind CronJob
+GET /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 CronJobList | OK |
list or watch objects of kind CronJob
+GET /apis/batch/v2alpha1/cronjobs
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 CronJobList | OK |
watch changes to an object of kind CronJob. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/batch/v2alpha1/watch/namespaces/{namespace}/cronjobs/{name}
+| Parameter | Description |
|---|---|
name | name of the CronJob |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of CronJob. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/batch/v2alpha1/watch/namespaces/{namespace}/cronjobs
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of CronJob. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/batch/v2alpha1/watch/cronjobs
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified CronJob
+PATCH /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}/status
+| Parameter | Description |
|---|---|
name | name of the CronJob |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 CronJob | OK |
read status of the specified CronJob
+GET /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}/status
+| Parameter | Description |
|---|---|
name | name of the CronJob |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 CronJob | OK |
replace status of the specified CronJob
+PUT /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}/status
+| Parameter | Description |
|---|---|
name | name of the CronJob |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyCronJob |
| Code | Description |
|---|---|
| 200 CronJob | OK |
| 201 CronJob | Created |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta2 | CrossVersionObjectReference |
| Field | Description |
|---|---|
apiVersionstring | API version of the referent |
kindstring | Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds" |
namestring | Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta1 | CrossVersionObjectReference |
| Field | Description |
|---|---|
apiVersionstring | API version of the referent |
kindstring | Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds" |
namestring | Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| Group | Version | Kind |
|---|---|---|
apps | v1beta2 | DaemonSet |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
specDaemonSetSpec | The desired behavior of this daemon set. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
statusDaemonSetStatus | The current status of this daemon set. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
minReadySecondsinteger | The minimum number of seconds for which a newly created DaemonSet 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). |
revisionHistoryLimitinteger | The number of old history to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10. |
selectorLabelSelector | A label query over pods that are managed by the daemon set. Must match in order to be controlled. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors |
templatePodTemplateSpec | An object that describes the pod that will be created. The DaemonSet will create exactly one copy of this pod on every node that matches the template's node selector (or on every node if no node selector is specified). More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template |
updateStrategyDaemonSetUpdateStrategy | An update strategy to replace existing DaemonSet pods with new pods. |
| Field | Description |
|---|---|
collisionCountinteger | Count of hash collisions for the DaemonSet. The DaemonSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision. |
conditionsDaemonSetCondition array patch strategy: merge patch merge key: type | Represents the latest available observations of a DaemonSet's current state. |
currentNumberScheduledinteger | The number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/ |
desiredNumberScheduledinteger | The total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/ |
numberAvailableinteger | The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and available (ready for at least spec.minReadySeconds) |
numberMisscheduledinteger | The number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/ |
numberReadyinteger | The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready. |
numberUnavailableinteger | The number of nodes that should be running the daemon pod and have none of the daemon pod running and available (ready for at least spec.minReadySeconds) |
observedGenerationinteger | The most recent generation observed by the daemon set controller. |
updatedNumberScheduledinteger | The total number of nodes that are running updated daemon pod |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsDaemonSet array | A list of daemon sets. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| Field | Description |
|---|---|
maxUnavailable | The maximum number of DaemonSet pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of total number of DaemonSet pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding up. This cannot be 0. Default value is 1. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their pods stopped for an update at any given time. The update starts by stopping at most 30% of those DaemonSet pods and then brings up new DaemonSet pods in their place. Once the new pods are available, it then proceeds onto other DaemonSet pods, thus ensuring that at least 70% of original number of DaemonSet pods are available at all times during the update. |
kubectl command
+$ echo 'apiVersion: extensions/v1beta1
+kind: DaemonSet
+metadata:
+ name: daemonset-example
+spec:
+ template:
+ metadata:
+ labels:
+ app: daemonset-example
+ spec:
+ containers:
+ - name: daemonset-example
+ image: ubuntu:trusty
+ command:
+ - /bin/sh
+ args:
+ - -c
+ - >-
+ while [ true ]; do
+ echo "DaemonSet running on $(hostname)" ;
+ sleep 10 ;
+ done
+' | kubectl create -f -
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X POST -H 'Content-Type: application/yaml' --data '
+apiVersion: extensions/v1beta1
+kind: DaemonSet
+metadata:
+ name: daemonset-example
+spec:
+ template:
+ metadata:
+ labels:
+ app: daemonset-example
+ spec:
+ containers:
+ - name: daemonset-example
+ image: ubuntu:trusty
+ command:
+ - /bin/sh
+ args:
+ - -c
+ - >-
+ while [ true ]; do
+ echo "DaemonSet running on $(hostname)" ;
+ sleep 10 ;
+ done
+' http://127.0.0.1:8001/apis/apps/v1beta2/namespaces/default/daemonsets
+
+daemonset "daemonset-example" created
+
+{
+ "kind": "DaemonSet",
+ "apiVersion": "extensions/v1beta1",
+ "metadata": {
+ "name": "daemonset-example",
+ "namespace": "default",
+ "selfLink": "/apis/extensions/v1beta1/namespaces/default/daemonsets/daemonset-example",
+ "uid": "65552ced-b0e2-11e6-aef0-42010af00229",
+ "resourceVersion": "3558",
+ "generation": 1,
+ "creationTimestamp": "2016-11-22T18:35:09Z",
+ "labels": {
+ "app": "daemonset-example"
+ }
+ },
+ "spec": {
+ "selector": {
+ "matchLabels": {
+ "app": "daemonset-example"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "daemonset-example"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "daemonset-example",
+ "image": "ubuntu:trusty",
+ "command": [
+ "/bin/sh"
+ ],
+ "args": [
+ "-c",
+ "while [ true ]; do echo \"DaemonSet running on $(hostname)\" ; sleep 10 ; done"
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ }
+ },
+ "status": {
+ "currentNumberScheduled": 0,
+ "numberMisscheduled": 0,
+ "desiredNumberScheduled": 0
+ }
+}
+create a DaemonSet
+POST /apis/apps/v1beta2/namespaces/{namespace}/daemonsets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyDaemonSet |
| Code | Description |
|---|---|
| 200 DaemonSet | OK |
| 201 DaemonSet | Created |
| 202 DaemonSet | Accepted |
partially update the specified DaemonSet
+PATCH /apis/apps/v1beta2/namespaces/{namespace}/daemonsets/{name}
+| Parameter | Description |
|---|---|
name | name of the DaemonSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 DaemonSet | OK |
replace the specified DaemonSet
+PUT /apis/apps/v1beta2/namespaces/{namespace}/daemonsets/{name}
+| Parameter | Description |
|---|---|
name | name of the DaemonSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyDaemonSet |
| Code | Description |
|---|---|
| 201 DaemonSet | Created |
| 200 DaemonSet | OK |
kubectl command
+$ kubectl delete daemonset daemonset-example
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
+gracePeriodSeconds: 0
+orphanDependents: false
+' 'http://127.0.0.1:8001/apis/apps/v1beta2/namespaces/default/daemonsets/daemonset-example'
+
+daemonset "daemonset-example" deleted
+
+{
+ "kind": "Status",
+ "apiVersion": "v1",
+ "metadata": {},
+ "status": "Success",
+ "code": 200
+}
+
+delete a DaemonSet
+DELETE /apis/apps/v1beta2/namespaces/{namespace}/daemonsets/{name}
+| Parameter | Description |
|---|---|
name | name of the DaemonSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of DaemonSet
+DELETE /apis/apps/v1beta2/namespaces/{namespace}/daemonsets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
kubectl command
+$ 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/v1beta2/namespaces/default/daemonsets/daemonset-example
+read the specified DaemonSet
+GET /apis/apps/v1beta2/namespaces/{namespace}/daemonsets/{name}
+| Parameter | Description |
|---|---|
name | name of the DaemonSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 DaemonSet | OK |
list or watch objects of kind DaemonSet
+GET /apis/apps/v1beta2/namespaces/{namespace}/daemonsets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 DaemonSetList | OK |
list or watch objects of kind DaemonSet
+GET /apis/apps/v1beta2/daemonsets
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 DaemonSetList | OK |
watch changes to an object of kind DaemonSet. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/apps/v1beta2/watch/namespaces/{namespace}/daemonsets/{name}
+| Parameter | Description |
|---|---|
name | name of the DaemonSet |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of DaemonSet. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/apps/v1beta2/watch/namespaces/{namespace}/daemonsets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of DaemonSet. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/apps/v1beta2/watch/daemonsets
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified DaemonSet
+PATCH /apis/apps/v1beta2/namespaces/{namespace}/daemonsets/{name}/status
+| Parameter | Description |
|---|---|
name | name of the DaemonSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 DaemonSet | OK |
read status of the specified DaemonSet
+GET /apis/apps/v1beta2/namespaces/{namespace}/daemonsets/{name}/status
+| Parameter | Description |
|---|---|
name | name of the DaemonSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 DaemonSet | OK |
replace status of the specified DaemonSet
+PUT /apis/apps/v1beta2/namespaces/{namespace}/daemonsets/{name}/status
+| Parameter | Description |
|---|---|
name | name of the DaemonSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyDaemonSet |
| Code | Description |
|---|---|
| 201 DaemonSet | Created |
| 200 DaemonSet | OK |
| Group | Version | Kind |
|---|---|---|
extensions | v1beta1 | DaemonSet |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
specDaemonSetSpec | The desired behavior of this daemon set. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
statusDaemonSetStatus | The current status of this daemon set. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
minReadySecondsinteger | The minimum number of seconds for which a newly created DaemonSet 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). |
revisionHistoryLimitinteger | The number of old history to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10. |
selectorLabelSelector | A label query over pods that are managed by the daemon set. Must match in order to be controlled. If empty, defaulted to labels on Pod template. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors |
templatePodTemplateSpec | An object that describes the pod that will be created. The DaemonSet will create exactly one copy of this pod on every node that matches the template's node selector (or on every node if no node selector is specified). More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template |
templateGenerationinteger | DEPRECATED. A sequence number representing a specific generation of the template. Populated by the system. It can be set only during the creation. |
updateStrategyDaemonSetUpdateStrategy | An update strategy to replace existing DaemonSet pods with new pods. |
| Field | Description |
|---|---|
collisionCountinteger | Count of hash collisions for the DaemonSet. The DaemonSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision. |
conditionsDaemonSetCondition array patch strategy: merge patch merge key: type | Represents the latest available observations of a DaemonSet's current state. |
currentNumberScheduledinteger | The number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/ |
desiredNumberScheduledinteger | The total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/ |
numberAvailableinteger | The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and available (ready for at least spec.minReadySeconds) |
numberMisscheduledinteger | The number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/ |
numberReadyinteger | The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready. |
numberUnavailableinteger | The number of nodes that should be running the daemon pod and have none of the daemon pod running and available (ready for at least spec.minReadySeconds) |
observedGenerationinteger | The most recent generation observed by the daemon set controller. |
updatedNumberScheduledinteger | The total number of nodes that are running updated daemon pod |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsDaemonSet array | A list of daemon sets. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| Field | Description |
|---|---|
maxUnavailable | The maximum number of DaemonSet pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of total number of DaemonSet pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding up. This cannot be 0. Default value is 1. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their pods stopped for an update at any given time. The update starts by stopping at most 30% of those DaemonSet pods and then brings up new DaemonSet pods in their place. Once the new pods are available, it then proceeds onto other DaemonSet pods, thus ensuring that at least 70% of original number of DaemonSet pods are available at all times during the update. |
kubectl command
+$ echo 'apiVersion: extensions/v1beta1
+kind: DaemonSet
+metadata:
+ name: daemonset-example
+spec:
+ template:
+ metadata:
+ labels:
+ app: daemonset-example
+ spec:
+ containers:
+ - name: daemonset-example
+ image: ubuntu:trusty
+ command:
+ - /bin/sh
+ args:
+ - -c
+ - >-
+ while [ true ]; do
+ echo "DaemonSet running on $(hostname)" ;
+ sleep 10 ;
+ done
+' | kubectl create -f -
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X POST -H 'Content-Type: application/yaml' --data '
+apiVersion: extensions/v1beta1
+kind: DaemonSet
+metadata:
+ name: daemonset-example
+spec:
+ template:
+ metadata:
+ labels:
+ app: daemonset-example
+ spec:
+ containers:
+ - name: daemonset-example
+ image: ubuntu:trusty
+ command:
+ - /bin/sh
+ args:
+ - -c
+ - >-
+ while [ true ]; do
+ echo "DaemonSet running on $(hostname)" ;
+ sleep 10 ;
+ done
+' http://127.0.0.1:8001/apis/extensions/v1beta1/namespaces/default/daemonsets
+
+daemonset "daemonset-example" created
+
+{
+ "kind": "DaemonSet",
+ "apiVersion": "extensions/v1beta1",
+ "metadata": {
+ "name": "daemonset-example",
+ "namespace": "default",
+ "selfLink": "/apis/extensions/v1beta1/namespaces/default/daemonsets/daemonset-example",
+ "uid": "65552ced-b0e2-11e6-aef0-42010af00229",
+ "resourceVersion": "3558",
+ "generation": 1,
+ "creationTimestamp": "2016-11-22T18:35:09Z",
+ "labels": {
+ "app": "daemonset-example"
+ }
+ },
+ "spec": {
+ "selector": {
+ "matchLabels": {
+ "app": "daemonset-example"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "daemonset-example"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "daemonset-example",
+ "image": "ubuntu:trusty",
+ "command": [
+ "/bin/sh"
+ ],
+ "args": [
+ "-c",
+ "while [ true ]; do echo \"DaemonSet running on $(hostname)\" ; sleep 10 ; done"
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ }
+ },
+ "status": {
+ "currentNumberScheduled": 0,
+ "numberMisscheduled": 0,
+ "desiredNumberScheduled": 0
+ }
+}
+create a DaemonSet
+POST /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyDaemonSet |
| Code | Description |
|---|---|
| 200 DaemonSet | OK |
| 201 DaemonSet | Created |
| 202 DaemonSet | Accepted |
partially update the specified DaemonSet
+PATCH /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}
+| Parameter | Description |
|---|---|
name | name of the DaemonSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 DaemonSet | OK |
replace the specified DaemonSet
+PUT /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}
+| Parameter | Description |
|---|---|
name | name of the DaemonSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyDaemonSet |
| Code | Description |
|---|---|
| 200 DaemonSet | OK |
| 201 DaemonSet | Created |
kubectl command
+$ kubectl delete daemonset daemonset-example
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
+gracePeriodSeconds: 0
+orphanDependents: false
+' 'http://127.0.0.1:8001/apis/extensions/v1beta1/namespaces/default/daemonsets/daemonset-example'
+
+daemonset "daemonset-example" deleted
+
+{
+ "kind": "Status",
+ "apiVersion": "v1",
+ "metadata": {},
+ "status": "Success",
+ "code": 200
+}
+
+delete a DaemonSet
+DELETE /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}
+| Parameter | Description |
|---|---|
name | name of the DaemonSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of DaemonSet
+DELETE /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
kubectl command
+$ 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/extensions/v1beta1/namespaces/default/daemonsets/daemonset-example
+read the specified DaemonSet
+GET /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}
+| Parameter | Description |
|---|---|
name | name of the DaemonSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 DaemonSet | OK |
list or watch objects of kind DaemonSet
+GET /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 DaemonSetList | OK |
list or watch objects of kind DaemonSet
+GET /apis/extensions/v1beta1/daemonsets
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 DaemonSetList | OK |
watch changes to an object of kind DaemonSet. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/daemonsets/{name}
+| Parameter | Description |
|---|---|
name | name of the DaemonSet |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of DaemonSet. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/daemonsets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of DaemonSet. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/extensions/v1beta1/watch/daemonsets
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified DaemonSet
+PATCH /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}/status
+| Parameter | Description |
|---|---|
name | name of the DaemonSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 DaemonSet | OK |
read status of the specified DaemonSet
+GET /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}/status
+| Parameter | Description |
|---|---|
name | name of the DaemonSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 DaemonSet | OK |
replace status of the specified DaemonSet
+PUT /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}/status
+| Parameter | Description |
|---|---|
name | name of the DaemonSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyDaemonSet |
| Code | Description |
|---|---|
| 201 DaemonSet | Created |
| 200 DaemonSet | OK |
| Group | Version | Kind |
|---|---|---|
apps | v1beta2 | DaemonSetCondition |
| Field | Description |
|---|---|
lastTransitionTimeTime | Last time the condition transitioned from one status to another. |
messagestring | A human readable message indicating details about the transition. |
reasonstring | The reason for the condition's last transition. |
statusstring | Status of the condition, one of True, False, Unknown. |
typestring | Type of DaemonSet condition. |
| Group | Version | Kind |
|---|---|---|
extensions | v1beta1 | DaemonSetCondition |
| Field | Description |
|---|---|
lastTransitionTimeTime | Last time the condition transitioned from one status to another. |
messagestring | A human readable message indicating details about the transition. |
reasonstring | The reason for the condition's last transition. |
statusstring | Status of the condition, one of True, False, Unknown. |
typestring | Type of DaemonSet condition. |
| Group | Version | Kind |
|---|---|---|
apps | v1beta2 | DaemonSetUpdateStrategy |
| Field | Description |
|---|---|
rollingUpdateRollingUpdateDaemonSet | Rolling update config params. Present only if type = "RollingUpdate". |
typestring | Type of daemon set update. Can be "RollingUpdate" or "OnDelete". Default is RollingUpdate. |
| Group | Version | Kind |
|---|---|---|
extensions | v1beta1 | DaemonSetUpdateStrategy |
| Field | Description |
|---|---|
rollingUpdateRollingUpdateDaemonSet | Rolling update config params. Present only if type = "RollingUpdate". |
typestring | Type of daemon set update. Can be "RollingUpdate" or "OnDelete". Default is OnDelete. |
| Group | Version | Kind |
|---|---|---|
apps | v1beta2 | Deployment |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object metadata. |
specDeploymentSpec | Specification of the desired behavior of the Deployment. |
statusDeploymentStatus | Most recently observed status of the Deployment. |
| Field | Description |
|---|---|
minReadySecondsinteger | 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) |
pausedboolean | Indicates that the deployment is paused. |
progressDeadlineSecondsinteger | 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. Defaults to 600s. |
replicasinteger | Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1. |
revisionHistoryLimitinteger | The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10. |
selectorLabelSelector | Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template's labels. |
strategyDeploymentStrategy patch strategy: retainKeys | The deployment strategy to use to replace existing pods with new ones. |
templatePodTemplateSpec | Template describes the pods that will be created. |
| Field | Description |
|---|---|
availableReplicasinteger | Total number of available pods (ready for at least minReadySeconds) targeted by this deployment. |
collisionCountinteger | 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. |
conditionsDeploymentCondition array patch strategy: merge patch merge key: type | Represents the latest available observations of a deployment's current state. |
observedGenerationinteger | The generation observed by the deployment controller. |
readyReplicasinteger | Total number of ready pods targeted by this deployment. |
replicasinteger | Total number of non-terminated pods targeted by this deployment (their labels match the selector). |
unavailableReplicasinteger | 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. |
updatedReplicasinteger | Total number of non-terminated pods targeted by this deployment that have the desired template spec. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsDeployment array | Items is the list of Deployments. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. |
| Field | Description |
|---|---|
rollingUpdateRollingUpdateDeployment | Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate. |
typestring | Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate. |
| Field | Description |
|---|---|
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 ReplicaSet 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 ReplicaSet 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. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods. |
kubectl command
+$ echo 'apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+ name: deployment-example
+spec:
+ replicas: 3
+ revisionHistoryLimit: 10
+ template:
+ metadata:
+ labels:
+ app: nginx
+ spec:
+ containers:
+ - name: nginx
+ image: nginx:1.10
+ ports:
+ - containerPort: 80
+' | kubectl create -f -
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X POST -H 'Content-Type: application/yaml' --data '
+apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+ name: deployment-example
+spec:
+ replicas: 3
+ revisionHistoryLimit: 10
+ template:
+ metadata:
+ labels:
+ app: nginx
+ spec:
+ containers:
+ - name: nginx
+ image: nginx:1.10
+ ports:
+ - containerPort: 80
+' http://127.0.0.1:8001/apis/apps/v1beta2/namespaces/default/deployments
+
+deployment "deployment-example" created
+
+{
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "4ccca349-9cb1-11e6-9c54-42010a800148",
+ "resourceVersion": "2118306",
+ "generation": 1,
+ "creationTimestamp": "2016-10-28T01:53:19Z",
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ },
+ "revisionHistoryLimit": 10
+ },
+ "status": {}
+}
+create a Deployment
+POST /apis/apps/v1beta2/namespaces/{namespace}/deployments
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyDeployment |
| Code | Description |
|---|---|
| 201 Deployment | Created |
| 202 Deployment | Accepted |
| 200 Deployment | OK |
kubectl command
+$ kubectl patch deployment deployment-example -p \
+ '{"spec":{"template":{"spec":{"containers":[{"name":"nginx","image":"nginx:1.11"}]}}}}'
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X PATCH -H 'Content-Type: application/strategic-merge-patch+json' --data '
+{"spec":{"template":{"spec":{"containers":[{"name":"nginx","image":"nginx:1.11"}]}}}}' \
+ 'http://127.0.0.1:8001/apis/apps/v1beta2/namespaces/default/deployments/deployment-example'
+
+"deployment-example" patched
+
+{
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "5dc3a8e6-b0ee-11e6-aef0-42010af00229",
+ "resourceVersion": "164489",
+ "generation": 11,
+ "creationTimestamp": "2016-11-22T20:00:50Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "5"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.11",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ },
+ "revisionHistoryLimit": 10
+ },
+ "status": {
+ "observedGeneration": 10,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+}
+
+partially update the specified Deployment
+PATCH /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}
+| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Deployment | OK |
kubectl command
+$ echo 'apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+ name: deployment-example
+spec:
+ replicas: 3
+ revisionHistoryLimit: 10
+ template:
+ metadata:
+ labels:
+ app: nginx
+ spec:
+ containers:
+ - name: nginx
+ image: nginx:1.11
+ ports:
+ - containerPort: 80
+' | kubectl replace -f -
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X PUT -H 'Content-Type: application/yaml' --data '
+apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+ name: deployment-example
+spec:
+ replicas: 3
+ revisionHistoryLimit: 10
+ template:
+ metadata:
+ labels:
+ app: nginx
+ spec:
+ containers:
+ - name: nginx
+ image: nginx:1.11
+ ports:
+ - containerPort: 80
+' http://127.0.0.1:8001/apis/apps/v1beta2/namespaces/default/deployments/deployment-example
+
+deployment "deployment-example" replaced
+
+{
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "4ccca349-9cb1-11e6-9c54-42010a800148",
+ "resourceVersion": "2119082",
+ "generation": 5,
+ "creationTimestamp": "2016-10-28T01:53:19Z",
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.11",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ },
+ "revisionHistoryLimit": 10
+ },
+ "status": {
+ "observedGeneration": 4,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+}
+
+replace the specified Deployment
+PUT /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}
+| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyDeployment |
| Code | Description |
|---|---|
| 200 Deployment | OK |
| 201 Deployment | Created |
kubectl command
+$ kubectl delete deployment deployment-example
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
+gracePeriodSeconds: 0
+orphanDependents: false
+' 'http://127.0.0.1:8001/apis/apps/v1beta2/namespaces/default/deployments/deployment-example'
+
+deployment "deployment-example" deleted
+
+{
+ "kind": "Status",
+ "apiVersion": "v1",
+ "metadata": {},
+ "status": "Success",
+ "code": 200
+}
+
+delete a Deployment
+DELETE /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}
+| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of Deployment
+DELETE /apis/apps/v1beta2/namespaces/{namespace}/deployments
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
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/v1beta2/namespaces/default/deployments/deployment-example
+
+{
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+ "resourceVersion": "2064726",
+ "generation": 4,
+ "creationTimestamp": "2016-10-27T16:33:35Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "1"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 4,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+}
+
+
+{
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+ "resourceVersion": "2064726",
+ "generation": 4,
+ "creationTimestamp": "2016-10-27T16:33:35Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "1"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 4,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+}
+
+read the specified Deployment
+GET /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}
+| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 Deployment | OK |
kubectl command
+$ kubectl get deployment -o json
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X GET 'http://127.0.0.1:8001/apis/apps/v1beta2/namespaces/default/deployments'
+
+{
+ "kind": "List",
+ "apiVersion": "v1",
+ "metadata": {},
+ "items": [
+ {
+ "kind": "Deployment",
+ "apiVersion": "app/v1beta1",
+ "metadata": {
+ "name": "docs",
+ "namespace": "default",
+ "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/docs",
+ "uid": "ef49e1d2-915e-11e6-be81-42010a80003f",
+ "resourceVersion": "1924126",
+ "generation": 21,
+ "creationTimestamp": "2016-10-13T16:06:00Z",
+ "labels": {
+ "run": "docs"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "10",
+ "replicatingperfection.net/push-image": "true"
+ }
+ },
+ "spec": {
+ "replicas": 1,
+ "selector": {
+ "matchLabels": {
+ "run": "docs"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "auto-pushed-image-pwittrock/api-docs": "1477496453",
+ "run": "docs"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "docs",
+ "image": "pwittrock/api-docs:v9",
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "Always"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 21,
+ "replicas": 1,
+ "updatedReplicas": 1,
+ "availableReplicas": 1
+ }
+ },
+ {
+ "kind": "Deployment",
+ "apiVersion": "app/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+ "resourceVersion": "2064726",
+ "generation": 4,
+ "creationTimestamp": "2016-10-27T16:33:35Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "1"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 4,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+ }
+ ]
+}
+
+
+{
+ "kind": "List",
+ "apiVersion": "v1",
+ "metadata": {},
+ "items": [
+ {
+ "kind": "Deployment",
+ "apiVersion": "app/v1beta1",
+ "metadata": {
+ "name": "docs",
+ "namespace": "default",
+ "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/docs",
+ "uid": "ef49e1d2-915e-11e6-be81-42010a80003f",
+ "resourceVersion": "1924126",
+ "generation": 21,
+ "creationTimestamp": "2016-10-13T16:06:00Z",
+ "labels": {
+ "run": "docs"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "10",
+ "replicatingperfection.net/push-image": "true"
+ }
+ },
+ "spec": {
+ "replicas": 1,
+ "selector": {
+ "matchLabels": {
+ "run": "docs"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "auto-pushed-image-pwittrock/api-docs": "1477496453",
+ "run": "docs"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "docs",
+ "image": "pwittrock/api-docs:v9",
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "Always"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 21,
+ "replicas": 1,
+ "updatedReplicas": 1,
+ "availableReplicas": 1
+ }
+ },
+ {
+ "kind": "Deployment",
+ "apiVersion": "app/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+ "resourceVersion": "2064726",
+ "generation": 4,
+ "creationTimestamp": "2016-10-27T16:33:35Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "1"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 4,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+ }
+ ]
+}
+
+list or watch objects of kind Deployment
+GET /apis/apps/v1beta2/namespaces/{namespace}/deployments
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 DeploymentList | OK |
list or watch objects of kind Deployment
+GET /apis/apps/v1beta2/deployments
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 DeploymentList | OK |
kubectl command
+$ kubectl get deployment deployment-example --watch -o json
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X GET 'http://127.0.0.1:8001/apis/apps/v1beta2/watch/namespaces/default/deployments/deployment-example'
+
+{
+ "type": "ADDED",
+ "object": {
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "64c12290-9cbf-11e6-9c54-42010a800148",
+ "resourceVersion": "2128095",
+ "generation": 2,
+ "creationTimestamp": "2016-10-28T03:34:12Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "3"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {
+ },
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {
+ }
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 2,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+ }
+}
+
+{
+ "type": "ADDED",
+ "object": {
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "64c12290-9cbf-11e6-9c54-42010a800148",
+ "resourceVersion": "2128095",
+ "generation": 2,
+ "creationTimestamp": "2016-10-28T03:34:12Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "3"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {
+ },
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {
+ }
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 2,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+ }
+}
+watch changes to an object of kind Deployment. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/apps/v1beta2/watch/namespaces/{namespace}/deployments/{name}
+| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Deployment. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/apps/v1beta2/watch/namespaces/{namespace}/deployments
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Deployment. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/apps/v1beta2/watch/deployments
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified Deployment
+PATCH /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}/status
+| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Deployment | OK |
read status of the specified Deployment
+GET /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}/status
+| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Deployment | OK |
replace status of the specified Deployment
+PUT /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}/status
+| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyDeployment |
| Code | Description |
|---|---|
| 200 Deployment | OK |
| 201 Deployment | Created |
read scale of the specified Deployment
+GET /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}/scale
+| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Scale | OK |
replace scale of the specified Deployment
+PUT /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}/scale
+| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyScale |
| Code | Description |
|---|---|
| 200 Scale | OK |
| 201 Scale | Created |
partially update scale of the specified Deployment
+PATCH /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}/scale
+| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Scale | OK |
| Group | Version | Kind |
|---|---|---|
apps | v1beta1 | Deployment |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object metadata. |
specDeploymentSpec | Specification of the desired behavior of the Deployment. |
statusDeploymentStatus | Most recently observed status of the Deployment. |
| Field | Description |
|---|---|
minReadySecondsinteger | 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) |
pausedboolean | Indicates that the deployment is paused. |
progressDeadlineSecondsinteger | 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. Defaults to 600s. |
replicasinteger | Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1. |
revisionHistoryLimitinteger | The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 2. |
rollbackToRollbackConfig | DEPRECATED. The config this deployment is rolling back to. Will be cleared after rollback is done. |
selectorLabelSelector | Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. |
strategyDeploymentStrategy patch strategy: retainKeys | The deployment strategy to use to replace existing pods with new ones. |
templatePodTemplateSpec | Template describes the pods that will be created. |
| Field | Description |
|---|---|
availableReplicasinteger | Total number of available pods (ready for at least minReadySeconds) targeted by this deployment. |
collisionCountinteger | 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. |
conditionsDeploymentCondition array patch strategy: merge patch merge key: type | Represents the latest available observations of a deployment's current state. |
observedGenerationinteger | The generation observed by the deployment controller. |
readyReplicasinteger | Total number of ready pods targeted by this deployment. |
replicasinteger | Total number of non-terminated pods targeted by this deployment (their labels match the selector). |
unavailableReplicasinteger | 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. |
updatedReplicasinteger | Total number of non-terminated pods targeted by this deployment that have the desired template spec. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsDeployment array | Items is the list of Deployments. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. |
| Field | Description |
|---|---|
rollingUpdateRollingUpdateDeployment | Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate. |
typestring | Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
namestring | Required: This must match the Name of a deployment. |
rollbackToRollbackConfig | The config of this deployment rollback. |
updatedAnnotationsobject | The annotations to be updated to a deployment |
| Field | Description |
|---|---|
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 ReplicaSet 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 ReplicaSet 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. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods. |
kubectl command
+$ echo 'apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+ name: deployment-example
+spec:
+ replicas: 3
+ revisionHistoryLimit: 10
+ template:
+ metadata:
+ labels:
+ app: nginx
+ spec:
+ containers:
+ - name: nginx
+ image: nginx:1.10
+ ports:
+ - containerPort: 80
+' | kubectl create -f -
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X POST -H 'Content-Type: application/yaml' --data '
+apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+ name: deployment-example
+spec:
+ replicas: 3
+ revisionHistoryLimit: 10
+ template:
+ metadata:
+ labels:
+ app: nginx
+ spec:
+ containers:
+ - name: nginx
+ image: nginx:1.10
+ ports:
+ - containerPort: 80
+' http://127.0.0.1:8001/apis/apps/v1beta1/namespaces/default/deployments
+
+deployment "deployment-example" created
+
+{
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "4ccca349-9cb1-11e6-9c54-42010a800148",
+ "resourceVersion": "2118306",
+ "generation": 1,
+ "creationTimestamp": "2016-10-28T01:53:19Z",
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ },
+ "revisionHistoryLimit": 10
+ },
+ "status": {}
+}
+create a Deployment
+POST /apis/apps/v1beta1/namespaces/{namespace}/deployments
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyDeployment |
| Code | Description |
|---|---|
| 200 Deployment | OK |
| 201 Deployment | Created |
| 202 Deployment | Accepted |
kubectl command
+$ kubectl patch deployment deployment-example -p \
+ '{"spec":{"template":{"spec":{"containers":[{"name":"nginx","image":"nginx:1.11"}]}}}}'
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X PATCH -H 'Content-Type: application/strategic-merge-patch+json' --data '
+{"spec":{"template":{"spec":{"containers":[{"name":"nginx","image":"nginx:1.11"}]}}}}' \
+ 'http://127.0.0.1:8001/apis/apps/v1beta1/namespaces/default/deployments/deployment-example'
+
+"deployment-example" patched
+
+{
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "5dc3a8e6-b0ee-11e6-aef0-42010af00229",
+ "resourceVersion": "164489",
+ "generation": 11,
+ "creationTimestamp": "2016-11-22T20:00:50Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "5"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.11",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ },
+ "revisionHistoryLimit": 10
+ },
+ "status": {
+ "observedGeneration": 10,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+}
+
+partially update the specified Deployment
+PATCH /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}
+| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Deployment | OK |
kubectl command
+$ echo 'apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+ name: deployment-example
+spec:
+ replicas: 3
+ revisionHistoryLimit: 10
+ template:
+ metadata:
+ labels:
+ app: nginx
+ spec:
+ containers:
+ - name: nginx
+ image: nginx:1.11
+ ports:
+ - containerPort: 80
+' | kubectl replace -f -
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X PUT -H 'Content-Type: application/yaml' --data '
+apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+ name: deployment-example
+spec:
+ replicas: 3
+ revisionHistoryLimit: 10
+ template:
+ metadata:
+ labels:
+ app: nginx
+ spec:
+ containers:
+ - name: nginx
+ image: nginx:1.11
+ ports:
+ - containerPort: 80
+' http://127.0.0.1:8001/apis/apps/v1beta1/namespaces/default/deployments/deployment-example
+
+deployment "deployment-example" replaced
+
+{
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "4ccca349-9cb1-11e6-9c54-42010a800148",
+ "resourceVersion": "2119082",
+ "generation": 5,
+ "creationTimestamp": "2016-10-28T01:53:19Z",
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.11",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ },
+ "revisionHistoryLimit": 10
+ },
+ "status": {
+ "observedGeneration": 4,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+}
+
+replace the specified Deployment
+PUT /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}
+| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyDeployment |
| Code | Description |
|---|---|
| 201 Deployment | Created |
| 200 Deployment | OK |
kubectl command
+$ kubectl delete deployment deployment-example
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
+gracePeriodSeconds: 0
+orphanDependents: false
+' 'http://127.0.0.1:8001/apis/apps/v1beta1/namespaces/default/deployments/deployment-example'
+
+deployment "deployment-example" deleted
+
+{
+ "kind": "Status",
+ "apiVersion": "v1",
+ "metadata": {},
+ "status": "Success",
+ "code": 200
+}
+
+delete a Deployment
+DELETE /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}
+| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of Deployment
+DELETE /apis/apps/v1beta1/namespaces/{namespace}/deployments
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
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
+
+{
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+ "resourceVersion": "2064726",
+ "generation": 4,
+ "creationTimestamp": "2016-10-27T16:33:35Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "1"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 4,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+}
+
+
+{
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+ "resourceVersion": "2064726",
+ "generation": 4,
+ "creationTimestamp": "2016-10-27T16:33:35Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "1"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 4,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+}
+
+read the specified Deployment
+GET /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}
+| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 Deployment | OK |
kubectl command
+$ kubectl get deployment -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'
+
+{
+ "kind": "List",
+ "apiVersion": "v1",
+ "metadata": {},
+ "items": [
+ {
+ "kind": "Deployment",
+ "apiVersion": "app/v1beta1",
+ "metadata": {
+ "name": "docs",
+ "namespace": "default",
+ "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/docs",
+ "uid": "ef49e1d2-915e-11e6-be81-42010a80003f",
+ "resourceVersion": "1924126",
+ "generation": 21,
+ "creationTimestamp": "2016-10-13T16:06:00Z",
+ "labels": {
+ "run": "docs"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "10",
+ "replicatingperfection.net/push-image": "true"
+ }
+ },
+ "spec": {
+ "replicas": 1,
+ "selector": {
+ "matchLabels": {
+ "run": "docs"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "auto-pushed-image-pwittrock/api-docs": "1477496453",
+ "run": "docs"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "docs",
+ "image": "pwittrock/api-docs:v9",
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "Always"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 21,
+ "replicas": 1,
+ "updatedReplicas": 1,
+ "availableReplicas": 1
+ }
+ },
+ {
+ "kind": "Deployment",
+ "apiVersion": "app/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+ "resourceVersion": "2064726",
+ "generation": 4,
+ "creationTimestamp": "2016-10-27T16:33:35Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "1"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 4,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+ }
+ ]
+}
+
+
+{
+ "kind": "List",
+ "apiVersion": "v1",
+ "metadata": {},
+ "items": [
+ {
+ "kind": "Deployment",
+ "apiVersion": "app/v1beta1",
+ "metadata": {
+ "name": "docs",
+ "namespace": "default",
+ "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/docs",
+ "uid": "ef49e1d2-915e-11e6-be81-42010a80003f",
+ "resourceVersion": "1924126",
+ "generation": 21,
+ "creationTimestamp": "2016-10-13T16:06:00Z",
+ "labels": {
+ "run": "docs"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "10",
+ "replicatingperfection.net/push-image": "true"
+ }
+ },
+ "spec": {
+ "replicas": 1,
+ "selector": {
+ "matchLabels": {
+ "run": "docs"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "auto-pushed-image-pwittrock/api-docs": "1477496453",
+ "run": "docs"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "docs",
+ "image": "pwittrock/api-docs:v9",
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "Always"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 21,
+ "replicas": 1,
+ "updatedReplicas": 1,
+ "availableReplicas": 1
+ }
+ },
+ {
+ "kind": "Deployment",
+ "apiVersion": "app/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+ "resourceVersion": "2064726",
+ "generation": 4,
+ "creationTimestamp": "2016-10-27T16:33:35Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "1"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 4,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+ }
+ ]
+}
+
+list or watch objects of kind Deployment
+GET /apis/apps/v1beta1/namespaces/{namespace}/deployments
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 DeploymentList | OK |
list or watch objects of kind Deployment
+GET /apis/apps/v1beta1/deployments
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 DeploymentList | OK |
kubectl command
+$ kubectl get deployment deployment-example --watch -o json
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X GET 'http://127.0.0.1:8001/apis/apps/v1beta1/watch/namespaces/default/deployments/deployment-example'
+
+{
+ "type": "ADDED",
+ "object": {
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "64c12290-9cbf-11e6-9c54-42010a800148",
+ "resourceVersion": "2128095",
+ "generation": 2,
+ "creationTimestamp": "2016-10-28T03:34:12Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "3"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {
+ },
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {
+ }
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 2,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+ }
+}
+
+{
+ "type": "ADDED",
+ "object": {
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "64c12290-9cbf-11e6-9c54-42010a800148",
+ "resourceVersion": "2128095",
+ "generation": 2,
+ "creationTimestamp": "2016-10-28T03:34:12Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "3"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {
+ },
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {
+ }
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 2,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+ }
+}
+watch changes to an object of kind Deployment. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/apps/v1beta1/watch/namespaces/{namespace}/deployments/{name}
+| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Deployment. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/apps/v1beta1/watch/namespaces/{namespace}/deployments
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Deployment. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/apps/v1beta1/watch/deployments
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified Deployment
+PATCH /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/status
+| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Deployment | OK |
read status of the specified Deployment
+GET /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/status
+| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Deployment | OK |
replace status of the specified Deployment
+PUT /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/status
+| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyDeployment |
| Code | Description |
|---|---|
| 200 Deployment | OK |
| 201 Deployment | Created |
read scale of the specified Deployment
+GET /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/scale
+| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Scale | OK |
replace scale of the specified Deployment
+PUT /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/scale
+| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyScale |
| Code | Description |
|---|---|
| 200 Scale | OK |
| 201 Scale | Created |
partially update scale of the specified Deployment
+PATCH /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/scale
+| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Scale | OK |
create rollback of a Deployment
+POST /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/rollback
+| Parameter | Description |
|---|---|
name | name of the DeploymentRollback |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
includeUninitialized | If IncludeUninitialized is specified, the object may be returned without completing initialization. |
pretty | If 'true', then the output is pretty printed. |
| Parameter | Description |
|---|---|
bodyDeploymentRollback |
| Code | Description |
|---|---|
| 200 Status | OK |
| 201 Status | Created |
| 202 Status | Accepted |
| Group | Version | Kind |
|---|---|---|
extensions | v1beta1 | Deployment |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object metadata. |
specDeploymentSpec | Specification of the desired behavior of the Deployment. |
statusDeploymentStatus | Most recently observed status of the Deployment. |
| Field | Description |
|---|---|
minReadySecondsinteger | 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) |
pausedboolean | Indicates that the deployment is paused and will not be processed by the deployment controller. |
progressDeadlineSecondsinteger | 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 set to the max value of int32 (i.e. 2147483647) by default, which means "no deadline". |
replicasinteger | Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1. |
revisionHistoryLimitinteger | The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. This is set to the max value of int32 (i.e. 2147483647) by default, which means "retaining all old RelicaSets". |
rollbackToRollbackConfig | DEPRECATED. The config this deployment is rolling back to. Will be cleared after rollback is done. |
selectorLabelSelector | Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. |
strategyDeploymentStrategy patch strategy: retainKeys | The deployment strategy to use to replace existing pods with new ones. |
templatePodTemplateSpec | Template describes the pods that will be created. |
| Field | Description |
|---|---|
availableReplicasinteger | Total number of available pods (ready for at least minReadySeconds) targeted by this deployment. |
collisionCountinteger | 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. |
conditionsDeploymentCondition array patch strategy: merge patch merge key: type | Represents the latest available observations of a deployment's current state. |
observedGenerationinteger | The generation observed by the deployment controller. |
readyReplicasinteger | Total number of ready pods targeted by this deployment. |
replicasinteger | Total number of non-terminated pods targeted by this deployment (their labels match the selector). |
unavailableReplicasinteger | 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. |
updatedReplicasinteger | Total number of non-terminated pods targeted by this deployment that have the desired template spec. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsDeployment array | Items is the list of Deployments. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. |
| Field | Description |
|---|---|
rollingUpdateRollingUpdateDeployment | Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate. |
typestring | Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
namestring | Required: This must match the Name of a deployment. |
rollbackToRollbackConfig | The config of this deployment rollback. |
updatedAnnotationsobject | The annotations to be updated to a deployment |
| Field | Description |
|---|---|
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. |
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. |
kubectl command
+$ echo 'apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+ name: deployment-example
+spec:
+ replicas: 3
+ revisionHistoryLimit: 10
+ template:
+ metadata:
+ labels:
+ app: nginx
+ spec:
+ containers:
+ - name: nginx
+ image: nginx:1.10
+ ports:
+ - containerPort: 80
+' | kubectl create -f -
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X POST -H 'Content-Type: application/yaml' --data '
+apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+ name: deployment-example
+spec:
+ replicas: 3
+ revisionHistoryLimit: 10
+ template:
+ metadata:
+ labels:
+ app: nginx
+ spec:
+ containers:
+ - name: nginx
+ image: nginx:1.10
+ ports:
+ - containerPort: 80
+' http://127.0.0.1:8001/apis/extensions/v1beta1/namespaces/default/deployments
+
+deployment "deployment-example" created
+
+{
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "4ccca349-9cb1-11e6-9c54-42010a800148",
+ "resourceVersion": "2118306",
+ "generation": 1,
+ "creationTimestamp": "2016-10-28T01:53:19Z",
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ },
+ "revisionHistoryLimit": 10
+ },
+ "status": {}
+}
+create a Deployment
+POST /apis/extensions/v1beta1/namespaces/{namespace}/deployments
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyDeployment |
| Code | Description |
|---|---|
| 200 Deployment | OK |
| 201 Deployment | Created |
| 202 Deployment | Accepted |
kubectl command
+$ kubectl patch deployment deployment-example -p \
+ '{"spec":{"template":{"spec":{"containers":[{"name":"nginx","image":"nginx:1.11"}]}}}}'
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X PATCH -H 'Content-Type: application/strategic-merge-patch+json' --data '
+{"spec":{"template":{"spec":{"containers":[{"name":"nginx","image":"nginx:1.11"}]}}}}' \
+ 'http://127.0.0.1:8001/apis/extensions/v1beta1/namespaces/default/deployments/deployment-example'
+
+"deployment-example" patched
+
+{
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "5dc3a8e6-b0ee-11e6-aef0-42010af00229",
+ "resourceVersion": "164489",
+ "generation": 11,
+ "creationTimestamp": "2016-11-22T20:00:50Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "5"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.11",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ },
+ "revisionHistoryLimit": 10
+ },
+ "status": {
+ "observedGeneration": 10,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+}
+
+partially update the specified Deployment
+PATCH /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}
+| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Deployment | OK |
kubectl command
+$ echo 'apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+ name: deployment-example
+spec:
+ replicas: 3
+ revisionHistoryLimit: 10
+ template:
+ metadata:
+ labels:
+ app: nginx
+ spec:
+ containers:
+ - name: nginx
+ image: nginx:1.11
+ ports:
+ - containerPort: 80
+' | kubectl replace -f -
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X PUT -H 'Content-Type: application/yaml' --data '
+apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+ name: deployment-example
+spec:
+ replicas: 3
+ revisionHistoryLimit: 10
+ template:
+ metadata:
+ labels:
+ app: nginx
+ spec:
+ containers:
+ - name: nginx
+ image: nginx:1.11
+ ports:
+ - containerPort: 80
+' http://127.0.0.1:8001/apis/extensions/v1beta1/namespaces/default/deployments/deployment-example
+
+deployment "deployment-example" replaced
+
+{
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "4ccca349-9cb1-11e6-9c54-42010a800148",
+ "resourceVersion": "2119082",
+ "generation": 5,
+ "creationTimestamp": "2016-10-28T01:53:19Z",
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.11",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ },
+ "revisionHistoryLimit": 10
+ },
+ "status": {
+ "observedGeneration": 4,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+}
+
+replace the specified Deployment
+PUT /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}
+| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyDeployment |
| Code | Description |
|---|---|
| 200 Deployment | OK |
| 201 Deployment | Created |
kubectl command
+$ kubectl delete deployment deployment-example
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
+gracePeriodSeconds: 0
+orphanDependents: false
+' 'http://127.0.0.1:8001/apis/extensions/v1beta1/namespaces/default/deployments/deployment-example'
+
+deployment "deployment-example" deleted
+
+{
+ "kind": "Status",
+ "apiVersion": "v1",
+ "metadata": {},
+ "status": "Success",
+ "code": 200
+}
+
+delete a Deployment
+DELETE /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}
+| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of Deployment
+DELETE /apis/extensions/v1beta1/namespaces/{namespace}/deployments
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
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/extensions/v1beta1/namespaces/default/deployments/deployment-example
+
+{
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+ "resourceVersion": "2064726",
+ "generation": 4,
+ "creationTimestamp": "2016-10-27T16:33:35Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "1"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 4,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+}
+
+
+{
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+ "resourceVersion": "2064726",
+ "generation": 4,
+ "creationTimestamp": "2016-10-27T16:33:35Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "1"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 4,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+}
+
+read the specified Deployment
+GET /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}
+| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 Deployment | OK |
kubectl command
+$ kubectl get deployment -o json
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X GET 'http://127.0.0.1:8001/apis/extensions/v1beta1/namespaces/default/deployments'
+
+{
+ "kind": "List",
+ "apiVersion": "v1",
+ "metadata": {},
+ "items": [
+ {
+ "kind": "Deployment",
+ "apiVersion": "app/v1beta1",
+ "metadata": {
+ "name": "docs",
+ "namespace": "default",
+ "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/docs",
+ "uid": "ef49e1d2-915e-11e6-be81-42010a80003f",
+ "resourceVersion": "1924126",
+ "generation": 21,
+ "creationTimestamp": "2016-10-13T16:06:00Z",
+ "labels": {
+ "run": "docs"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "10",
+ "replicatingperfection.net/push-image": "true"
+ }
+ },
+ "spec": {
+ "replicas": 1,
+ "selector": {
+ "matchLabels": {
+ "run": "docs"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "auto-pushed-image-pwittrock/api-docs": "1477496453",
+ "run": "docs"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "docs",
+ "image": "pwittrock/api-docs:v9",
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "Always"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 21,
+ "replicas": 1,
+ "updatedReplicas": 1,
+ "availableReplicas": 1
+ }
+ },
+ {
+ "kind": "Deployment",
+ "apiVersion": "app/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+ "resourceVersion": "2064726",
+ "generation": 4,
+ "creationTimestamp": "2016-10-27T16:33:35Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "1"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 4,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+ }
+ ]
+}
+
+
+{
+ "kind": "List",
+ "apiVersion": "v1",
+ "metadata": {},
+ "items": [
+ {
+ "kind": "Deployment",
+ "apiVersion": "app/v1beta1",
+ "metadata": {
+ "name": "docs",
+ "namespace": "default",
+ "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/docs",
+ "uid": "ef49e1d2-915e-11e6-be81-42010a80003f",
+ "resourceVersion": "1924126",
+ "generation": 21,
+ "creationTimestamp": "2016-10-13T16:06:00Z",
+ "labels": {
+ "run": "docs"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "10",
+ "replicatingperfection.net/push-image": "true"
+ }
+ },
+ "spec": {
+ "replicas": 1,
+ "selector": {
+ "matchLabels": {
+ "run": "docs"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "auto-pushed-image-pwittrock/api-docs": "1477496453",
+ "run": "docs"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "docs",
+ "image": "pwittrock/api-docs:v9",
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "Always"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 21,
+ "replicas": 1,
+ "updatedReplicas": 1,
+ "availableReplicas": 1
+ }
+ },
+ {
+ "kind": "Deployment",
+ "apiVersion": "app/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+ "resourceVersion": "2064726",
+ "generation": 4,
+ "creationTimestamp": "2016-10-27T16:33:35Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "1"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 4,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+ }
+ ]
+}
+
+list or watch objects of kind Deployment
+GET /apis/extensions/v1beta1/namespaces/{namespace}/deployments
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 DeploymentList | OK |
list or watch objects of kind Deployment
+GET /apis/extensions/v1beta1/deployments
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 DeploymentList | OK |
kubectl command
+$ kubectl get deployment deployment-example --watch -o json
+curl command (requires kubectl proxy to be running)
+$ kubectl proxy
+$ curl -X GET 'http://127.0.0.1:8001/apis/extensions/v1beta1/watch/namespaces/default/deployments/deployment-example'
+
+{
+ "type": "ADDED",
+ "object": {
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "64c12290-9cbf-11e6-9c54-42010a800148",
+ "resourceVersion": "2128095",
+ "generation": 2,
+ "creationTimestamp": "2016-10-28T03:34:12Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "3"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {
+ },
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {
+ }
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 2,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+ }
+}
+
+{
+ "type": "ADDED",
+ "object": {
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "64c12290-9cbf-11e6-9c54-42010a800148",
+ "resourceVersion": "2128095",
+ "generation": 2,
+ "creationTimestamp": "2016-10-28T03:34:12Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "3"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {
+ },
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {
+ }
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 2,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+ }
+}
+watch changes to an object of kind Deployment. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/deployments/{name}
+| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Deployment. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/deployments
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Deployment. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/extensions/v1beta1/watch/deployments
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified Deployment
+PATCH /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/status
+| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Deployment | OK |
read status of the specified Deployment
+GET /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/status
+| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Deployment | OK |
replace status of the specified Deployment
+PUT /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/status
+| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyDeployment |
| Code | Description |
|---|---|
| 200 Deployment | OK |
| 201 Deployment | Created |
read scale of the specified Deployment
+GET /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/scale
+| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Scale | OK |
replace scale of the specified Deployment
+PUT /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/scale
+| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyScale |
| Code | Description |
|---|---|
| 200 Scale | OK |
| 201 Scale | Created |
partially update scale of the specified Deployment
+PATCH /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/scale
+| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Scale | OK |
create rollback of a Deployment
+POST /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/rollback
+| Parameter | Description |
|---|---|
name | name of the DeploymentRollback |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
includeUninitialized | If IncludeUninitialized is specified, the object may be returned without completing initialization. |
pretty | If 'true', then the output is pretty printed. |
| Parameter | Description |
|---|---|
bodyDeploymentRollback |
| Code | Description |
|---|---|
| 200 Status | OK |
| 201 Status | Created |
| 202 Status | Accepted |
| Group | Version | Kind |
|---|---|---|
apps | v1beta2 | DeploymentCondition |
| Field | Description |
|---|---|
lastTransitionTimeTime | Last time the condition transitioned from one status to another. |
lastUpdateTimeTime | The last time this condition was updated. |
messagestring | A human readable message indicating details about the transition. |
reasonstring | The reason for the condition's last transition. |
statusstring | Status of the condition, one of True, False, Unknown. |
typestring | Type of deployment condition. |
| Group | Version | Kind |
|---|---|---|
apps | v1beta1 | DeploymentCondition |
| Field | Description |
|---|---|
lastTransitionTimeTime | Last time the condition transitioned from one status to another. |
lastUpdateTimeTime | The last time this condition was updated. |
messagestring | A human readable message indicating details about the transition. |
reasonstring | The reason for the condition's last transition. |
statusstring | Status of the condition, one of True, False, Unknown. |
typestring | Type of deployment condition. |
| Group | Version | Kind |
|---|---|---|
extensions | v1beta1 | DeploymentCondition |
| Field | Description |
|---|---|
lastTransitionTimeTime | Last time the condition transitioned from one status to another. |
lastUpdateTimeTime | The last time this condition was updated. |
messagestring | A human readable message indicating details about the transition. |
reasonstring | The reason for the condition's last transition. |
statusstring | Status of the condition, one of True, False, Unknown. |
typestring | Type of deployment condition. |
| Group | Version | Kind |
|---|---|---|
events.k8s.io | v1beta1 | Event |
| Field | Description |
|---|---|
actionstring | What action was taken/failed regarding to the regarding object. |
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
deprecatedCountinteger | Deprecated field assuring backward compatibility with core.v1 Event type |
deprecatedFirstTimestampTime | Deprecated field assuring backward compatibility with core.v1 Event type |
deprecatedLastTimestampTime | Deprecated field assuring backward compatibility with core.v1 Event type |
deprecatedSourceEventSource | Deprecated field assuring backward compatibility with core.v1 Event type |
eventTimeMicroTime | Required. Time when this Event was first observed. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | |
notestring | 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. |
reasonstring | Why the action was taken. |
regardingObjectReference | 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. |
relatedObjectReference | Optional secondary object for more complex actions. E.g. when regarding object triggers a creation or deletion of related object. |
reportingControllerstring | Name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`. |
reportingInstancestring | ID of the controller instance, e.g. `kubelet-xyzf`. |
seriesEventSeries | Data about the Event series this event represents or nil if it's a singleton Event. |
typestring | Type of this event (Normal, Warning), new types could be added in the future. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsEvent array | Items is a list of schema objects. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
create an Event
+POST /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyEvent |
| Code | Description |
|---|---|
| 201 Event | Created |
| 202 Event | Accepted |
| 200 Event | OK |
partially update the specified Event
+PATCH /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events/{name}
+| Parameter | Description |
|---|---|
name | name of the Event |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Event | OK |
replace the specified Event
+PUT /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events/{name}
+| Parameter | Description |
|---|---|
name | name of the Event |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyEvent |
| Code | Description |
|---|---|
| 200 Event | OK |
| 201 Event | Created |
delete an Event
+DELETE /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events/{name}
+| Parameter | Description |
|---|---|
name | name of the Event |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of Event
+DELETE /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified Event
+GET /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events/{name}
+| Parameter | Description |
|---|---|
name | name of the Event |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 Event | OK |
list or watch objects of kind Event
+GET /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 EventList | OK |
list or watch objects of kind Event
+GET /apis/events.k8s.io/v1beta1/events
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 EventList | OK |
watch changes to an object of kind Event. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/events.k8s.io/v1beta1/watch/namespaces/{namespace}/events/{name}
+| Parameter | Description |
|---|---|
name | name of the Event |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/events.k8s.io/v1beta1/watch/namespaces/{namespace}/events
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/events.k8s.io/v1beta1/watch/events
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
events.k8s.io | v1beta1 | EventSeries |
| Field | Description |
|---|---|
countinteger | Number of occurrences in this series up to the last heartbeat time |
lastObservedTimeMicroTime | Time when last Event from the series was seen before last heartbeat. |
statestring | Information whether this series is ongoing or finished. |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta1 | ExternalMetricSource |
| Field | Description |
|---|---|
metricNamestring | metricName is the name of the metric in question. |
metricSelectorLabelSelector | metricSelector is used to identify a specific time series within a given metric. |
targetAverageValueQuantity | targetAverageValue is the target per-pod value of global metric (as a quantity). Mutually exclusive with TargetValue. |
targetValueQuantity | targetValue is the target value of the metric (as a quantity). Mutually exclusive with TargetAverageValue. |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta1 | ExternalMetricStatus |
| Field | Description |
|---|---|
currentAverageValueQuantity | currentAverageValue is the current value of metric averaged over autoscaled pods. |
currentValueQuantity | currentValue is the current value of the metric (as a quantity) |
metricNamestring | metricName is the name of a metric used for autoscaling in metric system. |
metricSelectorLabelSelector | metricSelector is used to identify a specific time series within a given metric. |
| Group | Version | Kind |
|---|---|---|
policy | v1beta1 | FSGroupStrategyOptions |
| Field | Description |
|---|---|
rangesIDRange array | ranges are the allowed ranges of fs groups. If you would like to force a single fs group then supply a single range with the same start and end. Required for MustRunAs. |
rulestring | rule is the strategy that will dictate what FSGroup is used in the SecurityContext. |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta2 | HorizontalPodAutoscaler |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
specHorizontalPodAutoscalerSpec | spec is the specification for the behaviour of the autoscaler. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. |
statusHorizontalPodAutoscalerStatus | status is the current information about the autoscaler. |
| Field | Description |
|---|---|
maxReplicasinteger | maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas. |
metricsMetricSpec array | 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. If not set, the default metric will be set to 80% average CPU utilization. |
minReplicasinteger | minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. |
scaleTargetRefCrossVersionObjectReference | 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. |
| Field | Description |
|---|---|
conditionsHorizontalPodAutoscalerCondition array | conditions is the set of conditions required for this autoscaler to scale its target, and indicates whether or not those conditions are met. |
currentMetricsMetricStatus array | currentMetrics is the last read state of the metrics used by this autoscaler. |
currentReplicasinteger | currentReplicas is current number of replicas of pods managed by this autoscaler, as last seen by the autoscaler. |
desiredReplicasinteger | desiredReplicas is the desired number of replicas of pods managed by this autoscaler, as last calculated by the autoscaler. |
lastScaleTimeTime | 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. |
observedGenerationinteger | observedGeneration is the most recent generation observed by this autoscaler. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsHorizontalPodAutoscaler array | items is the list of horizontal pod autoscaler objects. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | metadata is the standard list metadata. |
create a HorizontalPodAutoscaler
+POST /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyHorizontalPodAutoscaler |
| Code | Description |
|---|---|
| 202 HorizontalPodAutoscaler | Accepted |
| 200 HorizontalPodAutoscaler | OK |
| 201 HorizontalPodAutoscaler | Created |
partially update the specified HorizontalPodAutoscaler
+PATCH /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{name}
+| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
replace the specified HorizontalPodAutoscaler
+PUT /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{name}
+| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyHorizontalPodAutoscaler |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
| 201 HorizontalPodAutoscaler | Created |
delete a HorizontalPodAutoscaler
+DELETE /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{name}
+| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of HorizontalPodAutoscaler
+DELETE /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified HorizontalPodAutoscaler
+GET /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{name}
+| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
list or watch objects of kind HorizontalPodAutoscaler
+GET /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscalerList | OK |
list or watch objects of kind HorizontalPodAutoscaler
+GET /apis/autoscaling/v2beta2/horizontalpodautoscalers
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscalerList | OK |
watch changes to an object of kind HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/autoscaling/v2beta2/watch/namespaces/{namespace}/horizontalpodautoscalers/{name}
+| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/autoscaling/v2beta2/watch/namespaces/{namespace}/horizontalpodautoscalers
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/autoscaling/v2beta2/watch/horizontalpodautoscalers
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified HorizontalPodAutoscaler
+PATCH /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
+| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
read status of the specified HorizontalPodAutoscaler
+GET /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
+| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
replace status of the specified HorizontalPodAutoscaler
+PUT /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
+| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyHorizontalPodAutoscaler |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
| 201 HorizontalPodAutoscaler | Created |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta1 | HorizontalPodAutoscaler |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
specHorizontalPodAutoscalerSpec | spec is the specification for the behaviour of the autoscaler. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. |
statusHorizontalPodAutoscalerStatus | status is the current information about the autoscaler. |
| Field | Description |
|---|---|
maxReplicasinteger | maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas. |
metricsMetricSpec array | 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. |
minReplicasinteger | minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. |
scaleTargetRefCrossVersionObjectReference | 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. |
| Field | Description |
|---|---|
conditionsHorizontalPodAutoscalerCondition array | conditions is the set of conditions required for this autoscaler to scale its target, and indicates whether or not those conditions are met. |
currentMetricsMetricStatus array | currentMetrics is the last read state of the metrics used by this autoscaler. |
currentReplicasinteger | currentReplicas is current number of replicas of pods managed by this autoscaler, as last seen by the autoscaler. |
desiredReplicasinteger | desiredReplicas is the desired number of replicas of pods managed by this autoscaler, as last calculated by the autoscaler. |
lastScaleTimeTime | 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. |
observedGenerationinteger | observedGeneration is the most recent generation observed by this autoscaler. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsHorizontalPodAutoscaler array | items is the list of horizontal pod autoscaler objects. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | metadata is the standard list metadata. |
create a HorizontalPodAutoscaler
+POST /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyHorizontalPodAutoscaler |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
| 201 HorizontalPodAutoscaler | Created |
| 202 HorizontalPodAutoscaler | Accepted |
partially update the specified HorizontalPodAutoscaler
+PATCH /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}
+| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
replace the specified HorizontalPodAutoscaler
+PUT /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}
+| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyHorizontalPodAutoscaler |
| Code | Description |
|---|---|
| 201 HorizontalPodAutoscaler | Created |
| 200 HorizontalPodAutoscaler | OK |
delete a HorizontalPodAutoscaler
+DELETE /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}
+| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of HorizontalPodAutoscaler
+DELETE /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified HorizontalPodAutoscaler
+GET /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}
+| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
list or watch objects of kind HorizontalPodAutoscaler
+GET /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscalerList | OK |
list or watch objects of kind HorizontalPodAutoscaler
+GET /apis/autoscaling/v2beta1/horizontalpodautoscalers
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscalerList | OK |
watch changes to an object of kind HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/autoscaling/v2beta1/watch/namespaces/{namespace}/horizontalpodautoscalers/{name}
+| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/autoscaling/v2beta1/watch/namespaces/{namespace}/horizontalpodautoscalers
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/autoscaling/v2beta1/watch/horizontalpodautoscalers
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified HorizontalPodAutoscaler
+PATCH /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
+| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
read status of the specified HorizontalPodAutoscaler
+GET /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
+| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
replace status of the specified HorizontalPodAutoscaler
+PUT /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
+| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyHorizontalPodAutoscaler |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
| 201 HorizontalPodAutoscaler | Created |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta1 | HorizontalPodAutoscalerCondition |
| Field | Description |
|---|---|
lastTransitionTimeTime | lastTransitionTime is the last time the condition transitioned from one status to another |
messagestring | message is a human-readable explanation containing details about the transition |
reasonstring | reason is the reason for the condition's last transition. |
statusstring | status is the status of the condition (True, False, Unknown) |
typestring | type describes the current condition |
| Group | Version | Kind |
|---|---|---|
policy | v1beta1 | HostPortRange |
| Field | Description |
|---|---|
maxinteger | max is the end of the range, inclusive. |
mininteger | min is the start of the range, inclusive. |
| Group | Version | Kind |
|---|---|---|
policy | v1beta1 | IDRange |
| Field | Description |
|---|---|
maxinteger | max is the end of the range, inclusive. |
mininteger | min is the start of the range, inclusive. |
| Group | Version | Kind |
|---|---|---|
extensions | v1beta1 | IPBlock |
| Field | Description |
|---|---|
cidrstring | CIDR is a string representing the IP Block Valid examples are "192.168.1.1/24" |
exceptstring 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 |
| Group | Version | Kind |
|---|---|---|
admissionregistration.k8s.io | v1alpha1 | Initializer |
| Field | Description |
|---|---|
namestring | 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 |
rulesRule array | 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. |
| Group | Version | Kind |
|---|---|---|
batch | v2alpha1 | JobTemplateSpec |
| Field | Description |
|---|---|
metadataObjectMeta | Standard object's metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
specJobSpec | Specification of the desired behavior of the job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
| Group | Version | Kind |
|---|---|---|
authorization.k8s.io | v1beta1 | LocalSubjectAccessReview |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | |
specSubjectAccessReviewSpec | 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. |
statusSubjectAccessReviewStatus | Status is filled in by the server and indicates whether the request is allowed or not |
create a LocalSubjectAccessReview
+POST /apis/authorization.k8s.io/v1beta1/namespaces/{namespace}/localsubjectaccessreviews
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
includeUninitialized | If IncludeUninitialized is specified, the object may be returned without completing initialization. |
pretty | If 'true', then the output is pretty printed. |
| Parameter | Description |
|---|---|
bodyLocalSubjectAccessReview |
| Code | Description |
|---|---|
| 201 LocalSubjectAccessReview | Created |
| 202 LocalSubjectAccessReview | Accepted |
| 200 LocalSubjectAccessReview | OK |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta1 | MetricSpec |
| Field | Description |
|---|---|
externalExternalMetricSource | external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster). |
objectObjectMetricSource | object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object). |
podsPodsMetricSource | pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value. |
resourceResourceMetricSource | resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. |
typestring | type is the type of metric source. It should be one of "Object", "Pods" or "Resource", each mapping to a matching field in the object. |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta1 | MetricStatus |
| Field | Description |
|---|---|
externalExternalMetricStatus | external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster). |
objectObjectMetricStatus | object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object). |
podsPodsMetricStatus | pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value. |
resourceResourceMetricStatus | resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. |
typestring | type is the type of metric source. It will be one of "Object", "Pods" or "Resource", each corresponds to a matching field in the object. |
| Group | Version | Kind |
|---|---|---|
extensions | v1beta1 | NetworkPolicy |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
specNetworkPolicySpec | Specification of the desired behavior for this NetworkPolicy. |
| Field | Description |
|---|---|
egressNetworkPolicyEgressRule array | 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 |
ingressNetworkPolicyIngressRule array | 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). |
podSelectorLabelSelector | 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. |
policyTypesstring 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 |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsNetworkPolicy array | Items is a list of schema objects. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
create a NetworkPolicy
+POST /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyNetworkPolicy |
| Code | Description |
|---|---|
| 200 NetworkPolicy | OK |
| 201 NetworkPolicy | Created |
| 202 NetworkPolicy | Accepted |
partially update the specified NetworkPolicy
+PATCH /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies/{name}
+| Parameter | Description |
|---|---|
name | name of the NetworkPolicy |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 NetworkPolicy | OK |
replace the specified NetworkPolicy
+PUT /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies/{name}
+| Parameter | Description |
|---|---|
name | name of the NetworkPolicy |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyNetworkPolicy |
| Code | Description |
|---|---|
| 200 NetworkPolicy | OK |
| 201 NetworkPolicy | Created |
delete a NetworkPolicy
+DELETE /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies/{name}
+| Parameter | Description |
|---|---|
name | name of the NetworkPolicy |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of NetworkPolicy
+DELETE /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified NetworkPolicy
+GET /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies/{name}
+| Parameter | Description |
|---|---|
name | name of the NetworkPolicy |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 NetworkPolicy | OK |
list or watch objects of kind NetworkPolicy
+GET /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 NetworkPolicyList | OK |
list or watch objects of kind NetworkPolicy
+GET /apis/extensions/v1beta1/networkpolicies
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 NetworkPolicyList | OK |
watch changes to an object of kind NetworkPolicy. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/networkpolicies/{name}
+| Parameter | Description |
|---|---|
name | name of the NetworkPolicy |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of NetworkPolicy. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/networkpolicies
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of NetworkPolicy. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/extensions/v1beta1/watch/networkpolicies
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
extensions | v1beta1 | NetworkPolicyEgressRule |
| Field | Description |
|---|---|
portsNetworkPolicyPort array | 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. |
toNetworkPolicyPeer array | 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. |
| Group | Version | Kind |
|---|---|---|
extensions | v1beta1 | NetworkPolicyIngressRule |
| Field | Description |
|---|---|
fromNetworkPolicyPeer array | 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. |
portsNetworkPolicyPort array | 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. |
| Group | Version | Kind |
|---|---|---|
extensions | v1beta1 | NetworkPolicyPeer |
| Field | Description |
|---|---|
ipBlockIPBlock | IPBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be. |
namespaceSelectorLabelSelector | Selects Namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces. If PodSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects all Pods in the Namespaces selected by NamespaceSelector. |
podSelectorLabelSelector | This is a label selector which selects Pods. This field follows standard label selector semantics; if present but empty, it selects all pods. If NamespaceSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects the Pods matching PodSelector in the policy's own Namespace. |
| Group | Version | Kind |
|---|---|---|
extensions | v1beta1 | NetworkPolicyPort |
| Field | Description |
|---|---|
port | 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. |
protocolstring | Optional. The protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP. |
| Group | Version | Kind |
|---|---|---|
authorization.k8s.io | v1beta1 | NonResourceAttributes |
| Field | Description |
|---|---|
pathstring | Path is the URL path of the request |
verbstring | Verb is the standard HTTP verb |
| Group | Version | Kind |
|---|---|---|
authorization.k8s.io | v1beta1 | NonResourceRule |
| Field | Description |
|---|---|
nonResourceURLsstring 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. |
verbsstring array | Verb is a list of kubernetes non-resource API verbs, like: get, post, put, delete, patch, head, options. "*" means all. |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta1 | ObjectMetricSource |
| Field | Description |
|---|---|
averageValueQuantity | averageValue is the target value of the average of the metric across all relevant pods (as a quantity) |
metricNamestring | metricName is the name of the metric in question. |
selectorLabelSelector | selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping When unset, just the metricName will be used to gather metrics. |
targetCrossVersionObjectReference | target is the described Kubernetes object. |
targetValueQuantity | targetValue is the target value of the metric (as a quantity). |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta1 | ObjectMetricStatus |
| Field | Description |
|---|---|
averageValueQuantity | averageValue is the current value of the average of the metric across all relevant pods (as a quantity) |
currentValueQuantity | currentValue is the current value of the metric (as a quantity). |
metricNamestring | metricName is the name of the metric in question. |
selectorLabelSelector | selector is the string-encoded form of a standard kubernetes label selector for the given metric When set in the ObjectMetricSource, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics. |
targetCrossVersionObjectReference | target is the described Kubernetes object. |
| Group | Version | Kind |
|---|---|---|
policy | v1beta1 | PodSecurityPolicy |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
specPodSecurityPolicySpec | spec defines the policy enforced. |
| Field | Description |
|---|---|
allowPrivilegeEscalationboolean | allowPrivilegeEscalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true. |
allowedCapabilitiesstring 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. |
allowedFlexVolumesAllowedFlexVolume array | 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. |
allowedHostPathsAllowedHostPath array | allowedHostPaths is a white list of allowed host paths. Empty indicates that all host paths may be used. |
allowedProcMountTypesstring array | AllowedProcMountTypes is a whitelist of allowed ProcMountTypes. Empty or nil indicates that only the DefaultProcMountType may be used. This requires the ProcMountType feature flag to be enabled. |
allowedUnsafeSysctlsstring array | allowedUnsafeSysctls is a list of explicitly allowed unsafe sysctls, defaults to none. Each entry is either a plain sysctl name or ends in "*" in which case it is considered as a prefix of allowed sysctls. Single * means all unsafe sysctls are allowed. Kubelet has to whitelist all allowed unsafe sysctls explicitly to avoid rejection. Examples: e.g. "foo/*" allows "foo/bar", "foo/baz", etc. e.g. "foo.*" allows "foo.bar", "foo.baz", etc. |
defaultAddCapabilitiesstring 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. |
defaultAllowPrivilegeEscalationboolean | defaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process. |
forbiddenSysctlsstring array | forbiddenSysctls is a list of explicitly forbidden sysctls, defaults to none. Each entry is either a plain sysctl name or ends in "*" in which case it is considered as a prefix of forbidden sysctls. Single * means all sysctls are forbidden. Examples: e.g. "foo/*" forbids "foo/bar", "foo/baz", etc. e.g. "foo.*" forbids "foo.bar", "foo.baz", etc. |
fsGroupFSGroupStrategyOptions | fsGroup is the strategy that will dictate what fs group is used by the SecurityContext. |
hostIPCboolean | hostIPC determines if the policy allows the use of HostIPC in the pod spec. |
hostNetworkboolean | hostNetwork determines if the policy allows the use of HostNetwork in the pod spec. |
hostPIDboolean | hostPID determines if the policy allows the use of HostPID in the pod spec. |
hostPortsHostPortRange array | hostPorts determines which host port ranges are allowed to be exposed. |
privilegedboolean | privileged determines if a pod can request to be run as privileged. |
readOnlyRootFilesystemboolean | 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. |
requiredDropCapabilitiesstring array | requiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added. |
runAsGroupRunAsGroupStrategyOptions | RunAsGroup is the strategy that will dictate the allowable RunAsGroup values that may be set. If this field is omitted, the pod's RunAsGroup can take any value. This field requires the RunAsGroup feature gate to be enabled. |
runAsUserRunAsUserStrategyOptions | runAsUser is the strategy that will dictate the allowable RunAsUser values that may be set. |
seLinuxSELinuxStrategyOptions | seLinux is the strategy that will dictate the allowable labels that may be set. |
supplementalGroupsSupplementalGroupsStrategyOptions | supplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext. |
volumesstring array | volumes is a white list of allowed volume plugins. Empty indicates that no volumes may be used. To allow all volumes you may use '\*'. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsPodSecurityPolicy array | items is a list of schema objects. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
create a PodSecurityPolicy
+POST /apis/policy/v1beta1/podsecuritypolicies
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPodSecurityPolicy |
| Code | Description |
|---|---|
| 202 PodSecurityPolicy | Accepted |
| 200 PodSecurityPolicy | OK |
| 201 PodSecurityPolicy | Created |
partially update the specified PodSecurityPolicy
+PATCH /apis/policy/v1beta1/podsecuritypolicies/{name}
+| Parameter | Description |
|---|---|
name | name of the PodSecurityPolicy |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 PodSecurityPolicy | OK |
replace the specified PodSecurityPolicy
+PUT /apis/policy/v1beta1/podsecuritypolicies/{name}
+| Parameter | Description |
|---|---|
name | name of the PodSecurityPolicy |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPodSecurityPolicy |
| Code | Description |
|---|---|
| 200 PodSecurityPolicy | OK |
| 201 PodSecurityPolicy | Created |
delete a PodSecurityPolicy
+DELETE /apis/policy/v1beta1/podsecuritypolicies/{name}
+| Parameter | Description |
|---|---|
name | name of the PodSecurityPolicy |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of PodSecurityPolicy
+DELETE /apis/policy/v1beta1/podsecuritypolicies
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified PodSecurityPolicy
+GET /apis/policy/v1beta1/podsecuritypolicies/{name}
+| Parameter | Description |
|---|---|
name | name of the PodSecurityPolicy |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 PodSecurityPolicy | OK |
list or watch objects of kind PodSecurityPolicy
+GET /apis/policy/v1beta1/podsecuritypolicies
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 PodSecurityPolicyList | OK |
watch changes to an object of kind PodSecurityPolicy. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/policy/v1beta1/watch/podsecuritypolicies/{name}
+| Parameter | Description |
|---|---|
name | name of the PodSecurityPolicy |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of PodSecurityPolicy. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/policy/v1beta1/watch/podsecuritypolicies
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta1 | PodsMetricSource |
| Field | Description |
|---|---|
metricNamestring | metricName is the name of the metric in question |
selectorLabelSelector | selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping When unset, just the metricName will be used to gather metrics. |
targetAverageValueQuantity | targetAverageValue is the target value of the average of the metric across all relevant pods (as a quantity) |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta1 | PodsMetricStatus |
| Field | Description |
|---|---|
currentAverageValueQuantity | currentAverageValue is the current value of the average of the metric across all relevant pods (as a quantity) |
metricNamestring | metricName is the name of the metric in question |
selectorLabelSelector | selector is the string-encoded form of a standard kubernetes label selector for the given metric When set in the PodsMetricSource, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics. |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1beta1 | PolicyRule |
| Field | Description |
|---|---|
apiGroupsstring 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. |
nonResourceURLsstring 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. |
resourceNamesstring array | ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. |
resourcesstring 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. |
verbsstring array | Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds. |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1alpha1 | PolicyRule |
| Field | Description |
|---|---|
apiGroupsstring 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. |
nonResourceURLsstring 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. |
resourceNamesstring array | ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. |
resourcesstring array | Resources is a list of resources this rule applies to. ResourceAll represents all resources. |
verbsstring array | Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds. |
| Group | Version | Kind |
|---|---|---|
scheduling.k8s.io | v1alpha1 | PriorityClass |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
descriptionstring | description is an arbitrary string that usually provides guidelines on when this priority class should be used. |
globalDefaultboolean | 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. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
valueinteger | The value of this priority class. This is the actual priority that pods receive when they have the name of this class in their pod spec. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsPriorityClass array | items is the list of PriorityClasses |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
create a PriorityClass
+POST /apis/scheduling.k8s.io/v1alpha1/priorityclasses
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPriorityClass |
| Code | Description |
|---|---|
| 200 PriorityClass | OK |
| 201 PriorityClass | Created |
| 202 PriorityClass | Accepted |
partially update the specified PriorityClass
+PATCH /apis/scheduling.k8s.io/v1alpha1/priorityclasses/{name}
+| Parameter | Description |
|---|---|
name | name of the PriorityClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 PriorityClass | OK |
replace the specified PriorityClass
+PUT /apis/scheduling.k8s.io/v1alpha1/priorityclasses/{name}
+| Parameter | Description |
|---|---|
name | name of the PriorityClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPriorityClass |
| Code | Description |
|---|---|
| 201 PriorityClass | Created |
| 200 PriorityClass | OK |
delete a PriorityClass
+DELETE /apis/scheduling.k8s.io/v1alpha1/priorityclasses/{name}
+| Parameter | Description |
|---|---|
name | name of the PriorityClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of PriorityClass
+DELETE /apis/scheduling.k8s.io/v1alpha1/priorityclasses
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified PriorityClass
+GET /apis/scheduling.k8s.io/v1alpha1/priorityclasses/{name}
+| Parameter | Description |
|---|---|
name | name of the PriorityClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 PriorityClass | OK |
list or watch objects of kind PriorityClass
+GET /apis/scheduling.k8s.io/v1alpha1/priorityclasses
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 PriorityClassList | OK |
watch changes to an object of kind PriorityClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/scheduling.k8s.io/v1alpha1/watch/priorityclasses/{name}
+| Parameter | Description |
|---|---|
name | name of the PriorityClass |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of PriorityClass. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/scheduling.k8s.io/v1alpha1/watch/priorityclasses
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
apps | v1beta2 | ReplicaSet |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
specReplicaSetSpec | Spec defines the specification of the desired behavior of the ReplicaSet. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
statusReplicaSetStatus | Status is the most recently observed status of the ReplicaSet. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
minReadySecondsinteger | 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) |
replicasinteger | Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller |
selectorLabelSelector | Selector is a label query over pods that should match the replica count. Label keys and values that must match in order to be controlled by this replica set. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors |
templatePodTemplateSpec | Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template |
| Field | Description |
|---|---|
availableReplicasinteger | The number of available replicas (ready for at least minReadySeconds) for this replica set. |
conditionsReplicaSetCondition array patch strategy: merge patch merge key: type | Represents the latest available observations of a replica set's current state. |
fullyLabeledReplicasinteger | The number of pods that have labels matching the labels of the pod template of the replicaset. |
observedGenerationinteger | ObservedGeneration reflects the generation of the most recently observed ReplicaSet. |
readyReplicasinteger | The number of ready replicas for this replica set. |
replicasinteger | Replicas is the most recently oberved number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsReplicaSet array | List of ReplicaSets. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
create a ReplicaSet
+POST /apis/apps/v1beta2/namespaces/{namespace}/replicasets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyReplicaSet |
| Code | Description |
|---|---|
| 200 ReplicaSet | OK |
| 201 ReplicaSet | Created |
| 202 ReplicaSet | Accepted |
partially update the specified ReplicaSet
+PATCH /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}
+| Parameter | Description |
|---|---|
name | name of the ReplicaSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ReplicaSet | OK |
replace the specified ReplicaSet
+PUT /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}
+| Parameter | Description |
|---|---|
name | name of the ReplicaSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyReplicaSet |
| Code | Description |
|---|---|
| 200 ReplicaSet | OK |
| 201 ReplicaSet | Created |
delete a ReplicaSet
+DELETE /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}
+| Parameter | Description |
|---|---|
name | name of the ReplicaSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of ReplicaSet
+DELETE /apis/apps/v1beta2/namespaces/{namespace}/replicasets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified ReplicaSet
+GET /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}
+| Parameter | Description |
|---|---|
name | name of the ReplicaSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 ReplicaSet | OK |
list or watch objects of kind ReplicaSet
+GET /apis/apps/v1beta2/namespaces/{namespace}/replicasets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 ReplicaSetList | OK |
list or watch objects of kind ReplicaSet
+GET /apis/apps/v1beta2/replicasets
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 ReplicaSetList | OK |
watch changes to an object of kind ReplicaSet. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/apps/v1beta2/watch/namespaces/{namespace}/replicasets/{name}
+| Parameter | Description |
|---|---|
name | name of the ReplicaSet |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ReplicaSet. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/apps/v1beta2/watch/namespaces/{namespace}/replicasets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ReplicaSet. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/apps/v1beta2/watch/replicasets
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified ReplicaSet
+PATCH /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}/status
+| Parameter | Description |
|---|---|
name | name of the ReplicaSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ReplicaSet | OK |
read status of the specified ReplicaSet
+GET /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}/status
+| Parameter | Description |
|---|---|
name | name of the ReplicaSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 ReplicaSet | OK |
replace status of the specified ReplicaSet
+PUT /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}/status
+| Parameter | Description |
|---|---|
name | name of the ReplicaSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyReplicaSet |
| Code | Description |
|---|---|
| 200 ReplicaSet | OK |
| 201 ReplicaSet | Created |
read scale of the specified ReplicaSet
+GET /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}/scale
+| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Scale | OK |
replace scale of the specified ReplicaSet
+PUT /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}/scale
+| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyScale |
| Code | Description |
|---|---|
| 200 Scale | OK |
| 201 Scale | Created |
partially update scale of the specified ReplicaSet
+PATCH /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}/scale
+| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Scale | OK |
| Group | Version | Kind |
|---|---|---|
extensions | v1beta1 | ReplicaSet |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
specReplicaSetSpec | Spec defines the specification of the desired behavior of the ReplicaSet. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
statusReplicaSetStatus | Status is the most recently observed status of the ReplicaSet. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
minReadySecondsinteger | 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) |
replicasinteger | Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller |
selectorLabelSelector | Selector is a label query over pods that should match the replica count. If the selector is empty, it is defaulted to the labels present on the pod template. Label keys and values that must match in order to be controlled by this replica set. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors |
templatePodTemplateSpec | Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template |
| Field | Description |
|---|---|
availableReplicasinteger | The number of available replicas (ready for at least minReadySeconds) for this replica set. |
conditionsReplicaSetCondition array patch strategy: merge patch merge key: type | Represents the latest available observations of a replica set's current state. |
fullyLabeledReplicasinteger | The number of pods that have labels matching the labels of the pod template of the replicaset. |
observedGenerationinteger | ObservedGeneration reflects the generation of the most recently observed ReplicaSet. |
readyReplicasinteger | The number of ready replicas for this replica set. |
replicasinteger | Replicas is the most recently oberved number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsReplicaSet array | List of ReplicaSets. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
create a ReplicaSet
+POST /apis/extensions/v1beta1/namespaces/{namespace}/replicasets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyReplicaSet |
| Code | Description |
|---|---|
| 202 ReplicaSet | Accepted |
| 200 ReplicaSet | OK |
| 201 ReplicaSet | Created |
partially update the specified ReplicaSet
+PATCH /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}
+| Parameter | Description |
|---|---|
name | name of the ReplicaSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ReplicaSet | OK |
replace the specified ReplicaSet
+PUT /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}
+| Parameter | Description |
|---|---|
name | name of the ReplicaSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyReplicaSet |
| Code | Description |
|---|---|
| 200 ReplicaSet | OK |
| 201 ReplicaSet | Created |
delete a ReplicaSet
+DELETE /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}
+| Parameter | Description |
|---|---|
name | name of the ReplicaSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of ReplicaSet
+DELETE /apis/extensions/v1beta1/namespaces/{namespace}/replicasets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified ReplicaSet
+GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}
+| Parameter | Description |
|---|---|
name | name of the ReplicaSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 ReplicaSet | OK |
list or watch objects of kind ReplicaSet
+GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 ReplicaSetList | OK |
list or watch objects of kind ReplicaSet
+GET /apis/extensions/v1beta1/replicasets
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 ReplicaSetList | OK |
watch changes to an object of kind ReplicaSet. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/replicasets/{name}
+| Parameter | Description |
|---|---|
name | name of the ReplicaSet |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ReplicaSet. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/replicasets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ReplicaSet. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/extensions/v1beta1/watch/replicasets
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified ReplicaSet
+PATCH /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/status
+| Parameter | Description |
|---|---|
name | name of the ReplicaSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ReplicaSet | OK |
read status of the specified ReplicaSet
+GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/status
+| Parameter | Description |
|---|---|
name | name of the ReplicaSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 ReplicaSet | OK |
replace status of the specified ReplicaSet
+PUT /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/status
+| Parameter | Description |
|---|---|
name | name of the ReplicaSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyReplicaSet |
| Code | Description |
|---|---|
| 200 ReplicaSet | OK |
| 201 ReplicaSet | Created |
read scale of the specified ReplicaSet
+GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/scale
+| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Scale | OK |
replace scale of the specified ReplicaSet
+PUT /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/scale
+| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyScale |
| Code | Description |
|---|---|
| 200 Scale | OK |
| 201 Scale | Created |
partially update scale of the specified ReplicaSet
+PATCH /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/scale
+| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Scale | OK |
| Group | Version | Kind |
|---|---|---|
apps | v1beta2 | ReplicaSetCondition |
| Field | Description |
|---|---|
lastTransitionTimeTime | The last time the condition transitioned from one status to another. |
messagestring | A human readable message indicating details about the transition. |
reasonstring | The reason for the condition's last transition. |
statusstring | Status of the condition, one of True, False, Unknown. |
typestring | Type of replica set condition. |
| Group | Version | Kind |
|---|---|---|
extensions | v1beta1 | ReplicaSetCondition |
| Field | Description |
|---|---|
lastTransitionTimeTime | The last time the condition transitioned from one status to another. |
messagestring | A human readable message indicating details about the transition. |
reasonstring | The reason for the condition's last transition. |
statusstring | Status of the condition, one of True, False, Unknown. |
typestring | Type of replica set condition. |
| Group | Version | Kind |
|---|---|---|
authorization.k8s.io | v1beta1 | ResourceAttributes |
| Field | Description |
|---|---|
groupstring | Group is the API Group of the Resource. "*" means all. |
namestring | Name is the name of the resource being requested for a "get" or deleted for a "delete". "" (empty) means all. |
namespacestring | 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 |
resourcestring | Resource is one of the existing resource types. "*" means all. |
subresourcestring | Subresource is one of the existing resource types. "" means none. |
verbstring | Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all. |
versionstring | Version is the API Version of the Resource. "*" means all. |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta1 | ResourceMetricSource |
| Field | Description |
|---|---|
namestring | name is the name of the resource in question. |
targetAverageUtilizationinteger | targetAverageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. |
targetAverageValueQuantity | targetAverageValue is the target value of the average of the resource metric across all relevant pods, as a raw value (instead of as a percentage of the request), similar to the "pods" metric source type. |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta1 | ResourceMetricStatus |
| Field | Description |
|---|---|
currentAverageUtilizationinteger | currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. It will only be present if `targetAverageValue` was set in the corresponding metric specification. |
currentAverageValueQuantity | currentAverageValue is the current value of the average of the resource metric across all relevant pods, as a raw value (instead of as a percentage of the request), similar to the "pods" metric source type. It will always be set, regardless of the corresponding metric specification. |
namestring | name is the name of the resource in question. |
| Group | Version | Kind |
|---|---|---|
authorization.k8s.io | v1beta1 | ResourceRule |
| Field | Description |
|---|---|
apiGroupsstring 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. |
resourceNamesstring array | ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. "*" means all. |
resourcesstring 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. |
verbsstring array | Verb is a list of kubernetes resource API verbs, like: get, list, watch, create, update, delete, proxy. "*" means all. |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1beta1 | Role |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. |
rulesPolicyRule array | Rules holds all the PolicyRules for this Role |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsRole array | Items is a list of Roles |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard object's metadata. |
create a Role
+POST /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyRole |
| Code | Description |
|---|---|
| 200 Role | OK |
| 201 Role | Created |
| 202 Role | Accepted |
partially update the specified Role
+PATCH /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name}
+| Parameter | Description |
|---|---|
name | name of the Role |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Role | OK |
replace the specified Role
+PUT /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name}
+| Parameter | Description |
|---|---|
name | name of the Role |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyRole |
| Code | Description |
|---|---|
| 201 Role | Created |
| 200 Role | OK |
delete a Role
+DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name}
+| Parameter | Description |
|---|---|
name | name of the Role |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of Role
+DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified Role
+GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name}
+| Parameter | Description |
|---|---|
name | name of the Role |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Role | OK |
list or watch objects of kind Role
+GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 RoleList | OK |
list or watch objects of kind Role
+GET /apis/rbac.authorization.k8s.io/v1beta1/roles
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 RoleList | OK |
watch changes to an object of kind Role. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/roles/{name}
+| Parameter | Description |
|---|---|
name | name of the Role |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Role. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/roles
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Role. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/rbac.authorization.k8s.io/v1beta1/watch/roles
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1alpha1 | Role |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. |
rulesPolicyRule array | Rules holds all the PolicyRules for this Role |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsRole array | Items is a list of Roles |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard object's metadata. |
create a Role
+POST /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyRole |
| Code | Description |
|---|---|
| 201 Role | Created |
| 202 Role | Accepted |
| 200 Role | OK |
partially update the specified Role
+PATCH /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles/{name}
+| Parameter | Description |
|---|---|
name | name of the Role |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Role | OK |
replace the specified Role
+PUT /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles/{name}
+| Parameter | Description |
|---|---|
name | name of the Role |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyRole |
| Code | Description |
|---|---|
| 200 Role | OK |
| 201 Role | Created |
delete a Role
+DELETE /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles/{name}
+| Parameter | Description |
|---|---|
name | name of the Role |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of Role
+DELETE /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified Role
+GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles/{name}
+| Parameter | Description |
|---|---|
name | name of the Role |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Role | OK |
list or watch objects of kind Role
+GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 RoleList | OK |
list or watch objects of kind Role
+GET /apis/rbac.authorization.k8s.io/v1alpha1/roles
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 RoleList | OK |
watch changes to an object of kind Role. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/roles/{name}
+| Parameter | Description |
|---|---|
name | name of the Role |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Role. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/roles
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Role. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/roles
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1beta1 | RoleBinding |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. |
roleRefRoleRef | 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. |
subjectsSubject array | Subjects holds references to the objects the role applies to. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsRoleBinding array | Items is a list of RoleBindings |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard object's metadata. |
create a RoleBinding
+POST /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyRoleBinding |
| Code | Description |
|---|---|
| 200 RoleBinding | OK |
| 201 RoleBinding | Created |
| 202 RoleBinding | Accepted |
partially update the specified RoleBinding
+PATCH /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name}
+| Parameter | Description |
|---|---|
name | name of the RoleBinding |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 RoleBinding | OK |
replace the specified RoleBinding
+PUT /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name}
+| Parameter | Description |
|---|---|
name | name of the RoleBinding |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyRoleBinding |
| Code | Description |
|---|---|
| 200 RoleBinding | OK |
| 201 RoleBinding | Created |
delete a RoleBinding
+DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name}
+| Parameter | Description |
|---|---|
name | name of the RoleBinding |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of RoleBinding
+DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified RoleBinding
+GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name}
+| Parameter | Description |
|---|---|
name | name of the RoleBinding |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 RoleBinding | OK |
list or watch objects of kind RoleBinding
+GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 RoleBindingList | OK |
list or watch objects of kind RoleBinding
+GET /apis/rbac.authorization.k8s.io/v1beta1/rolebindings
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 RoleBindingList | OK |
watch changes to an object of kind RoleBinding. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/rolebindings/{name}
+| Parameter | Description |
|---|---|
name | name of the RoleBinding |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of RoleBinding. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/rolebindings
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of RoleBinding. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/rbac.authorization.k8s.io/v1beta1/watch/rolebindings
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1alpha1 | RoleBinding |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. |
roleRefRoleRef | 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. |
subjectsSubject array | Subjects holds references to the objects the role applies to. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsRoleBinding array | Items is a list of RoleBindings |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard object's metadata. |
create a RoleBinding
+POST /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyRoleBinding |
| Code | Description |
|---|---|
| 200 RoleBinding | OK |
| 201 RoleBinding | Created |
| 202 RoleBinding | Accepted |
partially update the specified RoleBinding
+PATCH /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings/{name}
+| Parameter | Description |
|---|---|
name | name of the RoleBinding |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 RoleBinding | OK |
replace the specified RoleBinding
+PUT /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings/{name}
+| Parameter | Description |
|---|---|
name | name of the RoleBinding |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyRoleBinding |
| Code | Description |
|---|---|
| 200 RoleBinding | OK |
| 201 RoleBinding | Created |
delete a RoleBinding
+DELETE /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings/{name}
+| Parameter | Description |
|---|---|
name | name of the RoleBinding |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of RoleBinding
+DELETE /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified RoleBinding
+GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings/{name}
+| Parameter | Description |
|---|---|
name | name of the RoleBinding |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 RoleBinding | OK |
list or watch objects of kind RoleBinding
+GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 RoleBindingList | OK |
list or watch objects of kind RoleBinding
+GET /apis/rbac.authorization.k8s.io/v1alpha1/rolebindings
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 RoleBindingList | OK |
watch changes to an object of kind RoleBinding. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/rolebindings/{name}
+| Parameter | Description |
|---|---|
name | name of the RoleBinding |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of RoleBinding. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/rolebindings
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of RoleBinding. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/rolebindings
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1beta1 | RoleRef |
| Field | Description |
|---|---|
apiGroupstring | APIGroup is the group for the resource being referenced |
kindstring | Kind is the type of resource being referenced |
namestring | Name is the name of resource being referenced |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1alpha1 | RoleRef |
| Field | Description |
|---|---|
apiGroupstring | APIGroup is the group for the resource being referenced |
kindstring | Kind is the type of resource being referenced |
namestring | Name is the name of resource being referenced |
| Group | Version | Kind |
|---|---|---|
extensions | v1beta1 | RollbackConfig |
| Field | Description |
|---|---|
revisioninteger | The revision to rollback to. If set to 0, rollback to the last revision. |
| Group | Version | Kind |
|---|---|---|
apps | v1beta2 | RollingUpdateStatefulSetStrategy |
| Field | Description |
|---|---|
partitioninteger | Partition indicates the ordinal at which the StatefulSet should be partitioned. Default value is 0. |
| Group | Version | Kind |
|---|---|---|
apps | v1beta1 | RollingUpdateStatefulSetStrategy |
| Field | Description |
|---|---|
partitioninteger | Partition indicates the ordinal at which the StatefulSet should be partitioned. |
| Group | Version | Kind |
|---|---|---|
policy | v1beta1 | RunAsGroupStrategyOptions |
| Field | Description |
|---|---|
rangesIDRange array | ranges are the allowed ranges of gids that may be used. If you would like to force a single gid then supply a single range with the same start and end. Required for MustRunAs. |
rulestring | rule is the strategy that will dictate the allowable RunAsGroup values that may be set. |
| Group | Version | Kind |
|---|---|---|
policy | v1beta1 | RunAsUserStrategyOptions |
| Field | Description |
|---|---|
rangesIDRange array | ranges are the allowed ranges of uids that may be used. If you would like to force a single uid then supply a single range with the same start and end. Required for MustRunAs. |
rulestring | rule is the strategy that will dictate the allowable RunAsUser values that may be set. |
| Group | Version | Kind |
|---|---|---|
policy | v1beta1 | SELinuxStrategyOptions |
| Field | Description |
|---|---|
rulestring | rule is the strategy that will dictate the allowable labels that may be set. |
seLinuxOptionsSELinuxOptions | seLinuxOptions required to run as; required for MustRunAs More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ |
| Group | Version | Kind |
|---|---|---|
apps | v1beta2 | Scale |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata. |
specScaleSpec | defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. |
statusScaleStatus | current status of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. Read-only. |
| Field | Description |
|---|---|
replicasinteger | desired number of instances for the scaled object. |
| Field | Description |
|---|---|
replicasinteger | actual number of observed instances of the scaled object. |
selectorobject | label query over pods that should match the replicas count. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors |
targetSelectorstring | 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 |
| Group | Version | Kind |
|---|---|---|
apps | v1beta1 | Scale |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata. |
specScaleSpec | defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. |
statusScaleStatus | current status of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. Read-only. |
| Field | Description |
|---|---|
replicasinteger | desired number of instances for the scaled object. |
| Field | Description |
|---|---|
replicasinteger | actual number of observed instances of the scaled object. |
selectorobject | label query over pods that should match the replicas count. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors |
targetSelectorstring | 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 |
| Group | Version | Kind |
|---|---|---|
extensions | v1beta1 | Scale |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata. |
specScaleSpec | defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. |
statusScaleStatus | current status of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. Read-only. |
| Field | Description |
|---|---|
replicasinteger | desired number of instances for the scaled object. |
| Field | Description |
|---|---|
replicasinteger | actual number of observed instances of the scaled object. |
selectorobject | label query over pods that should match the replicas count. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors |
targetSelectorstring | 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 |
| Group | Version | Kind |
|---|---|---|
authorization.k8s.io | v1beta1 | SelfSubjectAccessReview |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | |
specSelfSubjectAccessReviewSpec | Spec holds information about the request being evaluated. user and groups must be empty |
statusSubjectAccessReviewStatus | Status is filled in by the server and indicates whether the request is allowed or not |
| Field | Description |
|---|---|
nonResourceAttributesNonResourceAttributes | NonResourceAttributes describes information for a non-resource access request |
resourceAttributesResourceAttributes | ResourceAuthorizationAttributes describes information for a resource access request |
create a SelfSubjectAccessReview
+POST /apis/authorization.k8s.io/v1beta1/selfsubjectaccessreviews
+| Parameter | Description |
|---|---|
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
includeUninitialized | If IncludeUninitialized is specified, the object may be returned without completing initialization. |
pretty | If 'true', then the output is pretty printed. |
| Parameter | Description |
|---|---|
bodySelfSubjectAccessReview |
| Code | Description |
|---|---|
| 201 SelfSubjectAccessReview | Created |
| 202 SelfSubjectAccessReview | Accepted |
| 200 SelfSubjectAccessReview | OK |
| Group | Version | Kind |
|---|---|---|
authorization.k8s.io | v1beta1 | SelfSubjectRulesReview |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | |
specSelfSubjectRulesReviewSpec | Spec holds information about the request being evaluated. |
statusSubjectRulesReviewStatus | Status is filled in by the server and indicates the set of actions a user can perform. |
| Field | Description |
|---|---|
namespacestring | Namespace to evaluate rules for. Required. |
create a SelfSubjectRulesReview
+POST /apis/authorization.k8s.io/v1beta1/selfsubjectrulesreviews
+| Parameter | Description |
|---|---|
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
includeUninitialized | If IncludeUninitialized is specified, the object may be returned without completing initialization. |
pretty | If 'true', then the output is pretty printed. |
| Parameter | Description |
|---|---|
bodySelfSubjectRulesReview |
| Code | Description |
|---|---|
| 200 SelfSubjectRulesReview | OK |
| 201 SelfSubjectRulesReview | Created |
| 202 SelfSubjectRulesReview | Accepted |
| Group | Version | Kind |
|---|---|---|
admissionregistration.k8s.io | v1beta1 | ServiceReference |
| Field | Description |
|---|---|
namestring | `name` is the name of the service. Required |
namespacestring | `namespace` is the namespace of the service. Required |
pathstring | `path` is an optional URL path which will be sent in any request to this service. |
| Group | Version | Kind |
|---|---|---|
apiextensions.k8s.io | v1beta1 | ServiceReference |
| Field | Description |
|---|---|
namestring | `name` is the name of the service. Required |
namespacestring | `namespace` is the namespace of the service. Required |
pathstring | `path` is an optional URL path which will be sent in any request to this service. |
| Group | Version | Kind |
|---|---|---|
apiregistration.k8s.io | v1beta1 | ServiceReference |
| Field | Description |
|---|---|
namestring | Name is the name of the service |
namespacestring | Namespace is the namespace of the service |
| Group | Version | Kind |
|---|---|---|
auditregistration.k8s.io | v1alpha1 | ServiceReference |
| Field | Description |
|---|---|
namestring | `name` is the name of the service. Required |
namespacestring | `namespace` is the namespace of the service. Required |
pathstring | `path` is an optional URL path which will be sent in any request to this service. |
| Group | Version | Kind |
|---|---|---|
apps | v1beta2 | StatefulSet |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | |
specStatefulSetSpec | Spec defines the desired identities of pods in this set. |
statusStatefulSetStatus | Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time. |
| Field | Description |
|---|---|
podManagementPolicystring | 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. |
replicasinteger | 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. |
revisionHistoryLimitinteger | 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. |
selectorLabelSelector | selector is a label query over pods that should match the replica count. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors |
serviceNamestring | 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. |
templatePodTemplateSpec | 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. |
updateStrategyStatefulSetUpdateStrategy | updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template. |
volumeClaimTemplatesPersistentVolumeClaim array | 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. |
| Field | Description |
|---|---|
collisionCountinteger | 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. |
conditionsStatefulSetCondition array patch strategy: merge patch merge key: type | Represents the latest available observations of a statefulset's current state. |
currentReplicasinteger | currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision. |
currentRevisionstring | currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas). |
observedGenerationinteger | 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. |
readyReplicasinteger | readyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition. |
replicasinteger | replicas is the number of Pods created by the StatefulSet controller. |
updateRevisionstring | updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [replicas-updatedReplicas,replicas) |
updatedReplicasinteger | updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsStatefulSet array | |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta |
create a StatefulSet
+POST /apis/apps/v1beta2/namespaces/{namespace}/statefulsets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyStatefulSet |
| Code | Description |
|---|---|
| 201 StatefulSet | Created |
| 202 StatefulSet | Accepted |
| 200 StatefulSet | OK |
partially update the specified StatefulSet
+PATCH /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}
+| Parameter | Description |
|---|---|
name | name of the StatefulSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 StatefulSet | OK |
replace the specified StatefulSet
+PUT /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}
+| Parameter | Description |
|---|---|
name | name of the StatefulSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyStatefulSet |
| Code | Description |
|---|---|
| 201 StatefulSet | Created |
| 200 StatefulSet | OK |
delete a StatefulSet
+DELETE /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}
+| Parameter | Description |
|---|---|
name | name of the StatefulSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of StatefulSet
+DELETE /apis/apps/v1beta2/namespaces/{namespace}/statefulsets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified StatefulSet
+GET /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}
+| Parameter | Description |
|---|---|
name | name of the StatefulSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 StatefulSet | OK |
list or watch objects of kind StatefulSet
+GET /apis/apps/v1beta2/namespaces/{namespace}/statefulsets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 StatefulSetList | OK |
list or watch objects of kind StatefulSet
+GET /apis/apps/v1beta2/statefulsets
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 StatefulSetList | OK |
watch changes to an object of kind StatefulSet. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/apps/v1beta2/watch/namespaces/{namespace}/statefulsets/{name}
+| Parameter | Description |
|---|---|
name | name of the StatefulSet |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of StatefulSet. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/apps/v1beta2/watch/namespaces/{namespace}/statefulsets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of StatefulSet. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/apps/v1beta2/watch/statefulsets
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified StatefulSet
+PATCH /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}/status
+| Parameter | Description |
|---|---|
name | name of the StatefulSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 StatefulSet | OK |
read status of the specified StatefulSet
+GET /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}/status
+| Parameter | Description |
|---|---|
name | name of the StatefulSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 StatefulSet | OK |
replace status of the specified StatefulSet
+PUT /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}/status
+| Parameter | Description |
|---|---|
name | name of the StatefulSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyStatefulSet |
| Code | Description |
|---|---|
| 200 StatefulSet | OK |
| 201 StatefulSet | Created |
read scale of the specified StatefulSet
+GET /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}/scale
+| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Scale | OK |
replace scale of the specified StatefulSet
+PUT /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}/scale
+| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyScale |
| Code | Description |
|---|---|
| 200 Scale | OK |
| 201 Scale | Created |
partially update scale of the specified StatefulSet
+PATCH /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}/scale
+| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Scale | OK |
| Group | Version | Kind |
|---|---|---|
apps | v1beta1 | StatefulSet |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | |
specStatefulSetSpec | Spec defines the desired identities of pods in this set. |
statusStatefulSetStatus | Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time. |
| Field | Description |
|---|---|
podManagementPolicystring | 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. |
replicasinteger | 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. |
revisionHistoryLimitinteger | 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. |
selectorLabelSelector | selector is a label query over pods that should match the replica count. If empty, defaulted to labels on the pod template. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors |
serviceNamestring | 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. |
templatePodTemplateSpec | 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. |
updateStrategyStatefulSetUpdateStrategy | updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template. |
volumeClaimTemplatesPersistentVolumeClaim array | 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. |
| Field | Description |
|---|---|
collisionCountinteger | 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. |
conditionsStatefulSetCondition array patch strategy: merge patch merge key: type | Represents the latest available observations of a statefulset's current state. |
currentReplicasinteger | currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision. |
currentRevisionstring | currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas). |
observedGenerationinteger | 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. |
readyReplicasinteger | readyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition. |
replicasinteger | replicas is the number of Pods created by the StatefulSet controller. |
updateRevisionstring | updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [replicas-updatedReplicas,replicas) |
updatedReplicasinteger | updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsStatefulSet array | |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta |
create a StatefulSet
+POST /apis/apps/v1beta1/namespaces/{namespace}/statefulsets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyStatefulSet |
| Code | Description |
|---|---|
| 200 StatefulSet | OK |
| 201 StatefulSet | Created |
| 202 StatefulSet | Accepted |
partially update the specified StatefulSet
+PATCH /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}
+| Parameter | Description |
|---|---|
name | name of the StatefulSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 StatefulSet | OK |
replace the specified StatefulSet
+PUT /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}
+| Parameter | Description |
|---|---|
name | name of the StatefulSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyStatefulSet |
| Code | Description |
|---|---|
| 200 StatefulSet | OK |
| 201 StatefulSet | Created |
delete a StatefulSet
+DELETE /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}
+| Parameter | Description |
|---|---|
name | name of the StatefulSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of StatefulSet
+DELETE /apis/apps/v1beta1/namespaces/{namespace}/statefulsets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified StatefulSet
+GET /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}
+| Parameter | Description |
|---|---|
name | name of the StatefulSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 StatefulSet | OK |
list or watch objects of kind StatefulSet
+GET /apis/apps/v1beta1/namespaces/{namespace}/statefulsets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 StatefulSetList | OK |
list or watch objects of kind StatefulSet
+GET /apis/apps/v1beta1/statefulsets
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 StatefulSetList | OK |
watch changes to an object of kind StatefulSet. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/apps/v1beta1/watch/namespaces/{namespace}/statefulsets/{name}
+| Parameter | Description |
|---|---|
name | name of the StatefulSet |
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of StatefulSet. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/apps/v1beta1/watch/namespaces/{namespace}/statefulsets
+| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of StatefulSet. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/apps/v1beta1/watch/statefulsets
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified StatefulSet
+PATCH /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/status
+| Parameter | Description |
|---|---|
name | name of the StatefulSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 StatefulSet | OK |
read status of the specified StatefulSet
+GET /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/status
+| Parameter | Description |
|---|---|
name | name of the StatefulSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 StatefulSet | OK |
replace status of the specified StatefulSet
+PUT /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/status
+| Parameter | Description |
|---|---|
name | name of the StatefulSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyStatefulSet |
| Code | Description |
|---|---|
| 200 StatefulSet | OK |
| 201 StatefulSet | Created |
read scale of the specified StatefulSet
+GET /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/scale
+| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Scale | OK |
replace scale of the specified StatefulSet
+PUT /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/scale
+| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyScale |
| Code | Description |
|---|---|
| 200 Scale | OK |
| 201 Scale | Created |
partially update scale of the specified StatefulSet
+PATCH /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/scale
+| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Scale | OK |
| Group | Version | Kind |
|---|---|---|
apps | v1beta2 | StatefulSetCondition |
| Field | Description |
|---|---|
lastTransitionTimeTime | Last time the condition transitioned from one status to another. |
messagestring | A human readable message indicating details about the transition. |
reasonstring | The reason for the condition's last transition. |
statusstring | Status of the condition, one of True, False, Unknown. |
typestring | Type of statefulset condition. |
| Group | Version | Kind |
|---|---|---|
apps | v1beta1 | StatefulSetCondition |
| Field | Description |
|---|---|
lastTransitionTimeTime | Last time the condition transitioned from one status to another. |
messagestring | A human readable message indicating details about the transition. |
reasonstring | The reason for the condition's last transition. |
statusstring | Status of the condition, one of True, False, Unknown. |
typestring | Type of statefulset condition. |
| Group | Version | Kind |
|---|---|---|
apps | v1beta2 | StatefulSetUpdateStrategy |
| Field | Description |
|---|---|
rollingUpdateRollingUpdateStatefulSetStrategy | RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType. |
typestring | Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate. |
| Group | Version | Kind |
|---|---|---|
apps | v1beta1 | StatefulSetUpdateStrategy |
| Field | Description |
|---|---|
rollingUpdateRollingUpdateStatefulSetStrategy | RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType. |
typestring | Type indicates the type of the StatefulSetUpdateStrategy. |
| Group | Version | Kind |
|---|---|---|
storage.k8s.io | v1beta1 | StorageClass |
| Field | Description |
|---|---|
allowVolumeExpansionboolean | AllowVolumeExpansion shows whether the storage class allow volume expand |
allowedTopologiesTopologySelectorTerm array | Restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature. |
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
mountOptionsstring 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. |
parametersobject | Parameters holds the parameters for the provisioner that should create volumes of this storage class. |
provisionerstring | Provisioner indicates the type of the provisioner. |
reclaimPolicystring | Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. Defaults to Delete. |
volumeBindingModestring | VolumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is only honored by servers that enable the VolumeScheduling feature. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsStorageClass array | Items is the list of StorageClasses |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
create a StorageClass
+POST /apis/storage.k8s.io/v1beta1/storageclasses
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyStorageClass |
| Code | Description |
|---|---|
| 200 StorageClass | OK |
| 201 StorageClass | Created |
| 202 StorageClass | Accepted |
partially update the specified StorageClass
+PATCH /apis/storage.k8s.io/v1beta1/storageclasses/{name}
+| Parameter | Description |
|---|---|
name | name of the StorageClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 StorageClass | OK |
replace the specified StorageClass
+PUT /apis/storage.k8s.io/v1beta1/storageclasses/{name}
+| Parameter | Description |
|---|---|
name | name of the StorageClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyStorageClass |
| Code | Description |
|---|---|
| 200 StorageClass | OK |
| 201 StorageClass | Created |
delete a StorageClass
+DELETE /apis/storage.k8s.io/v1beta1/storageclasses/{name}
+| Parameter | Description |
|---|---|
name | name of the StorageClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of StorageClass
+DELETE /apis/storage.k8s.io/v1beta1/storageclasses
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified StorageClass
+GET /apis/storage.k8s.io/v1beta1/storageclasses/{name}
+| Parameter | Description |
|---|---|
name | name of the StorageClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 StorageClass | OK |
list or watch objects of kind StorageClass
+GET /apis/storage.k8s.io/v1beta1/storageclasses
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 StorageClassList | OK |
watch changes to an object of kind StorageClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/storage.k8s.io/v1beta1/watch/storageclasses/{name}
+| Parameter | Description |
|---|---|
name | name of the StorageClass |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of StorageClass. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/storage.k8s.io/v1beta1/watch/storageclasses
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1beta1 | Subject |
| Field | Description |
|---|---|
apiGroupstring | 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. |
kindstring | 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. |
namestring | Name of the object being referenced. |
namespacestring | 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. |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1alpha1 | Subject |
| Field | Description |
|---|---|
apiVersionstring | 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. |
kindstring | 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. |
namestring | Name of the object being referenced. |
namespacestring | 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. |
| Group | Version | Kind |
|---|---|---|
authorization.k8s.io | v1beta1 | SubjectAccessReview |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | |
specSubjectAccessReviewSpec | Spec holds information about the request being evaluated |
statusSubjectAccessReviewStatus | Status is filled in by the server and indicates whether the request is allowed or not |
| Field | Description |
|---|---|
extraobject | Extra corresponds to the user.Info.GetExtra() method from the authenticator. Since that is input to the authorizer it needs a reflection here. |
groupstring array | Groups is the groups you're testing for. |
nonResourceAttributesNonResourceAttributes | NonResourceAttributes describes information for a non-resource access request |
resourceAttributesResourceAttributes | ResourceAuthorizationAttributes describes information for a resource access request |
uidstring | UID information about the requesting user. |
userstring | 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 |
| Field | Description |
|---|---|
allowedboolean | Allowed is required. True if the action would be allowed, false otherwise. |
deniedboolean | 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. |
evaluationErrorstring | 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. |
reasonstring | Reason is optional. It indicates why a request was allowed or denied. |
create a SubjectAccessReview
+POST /apis/authorization.k8s.io/v1beta1/subjectaccessreviews
+| Parameter | Description |
|---|---|
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
includeUninitialized | If IncludeUninitialized is specified, the object may be returned without completing initialization. |
pretty | If 'true', then the output is pretty printed. |
| Parameter | Description |
|---|---|
bodySubjectAccessReview |
| Code | Description |
|---|---|
| 202 SubjectAccessReview | Accepted |
| 200 SubjectAccessReview | OK |
| 201 SubjectAccessReview | Created |
| Group | Version | Kind |
|---|---|---|
authorization.k8s.io | v1beta1 | SubjectRulesReviewStatus |
| Field | Description |
|---|---|
evaluationErrorstring | 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. |
incompleteboolean | 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. |
nonResourceRulesNonResourceRule array | 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. |
resourceRulesResourceRule array | 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. |
| Group | Version | Kind |
|---|---|---|
policy | v1beta1 | SupplementalGroupsStrategyOptions |
| Field | Description |
|---|---|
rangesIDRange array | 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. Required for MustRunAs. |
rulestring | rule is the strategy that will dictate what supplemental groups is used in the SecurityContext. |
| Group | Version | Kind |
|---|---|---|
authentication.k8s.io | v1beta1 | TokenReview |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | |
specTokenReviewSpec | Spec holds information about the request being evaluated |
statusTokenReviewStatus | Status is filled in by the server and indicates whether the request can be authenticated. |
| Field | Description |
|---|---|
audiencesstring array | Audiences is a list of the identifiers that the resource server presented with the token identifies as. Audience-aware token authenticators will verify that the token was intended for at least one of the audiences in this list. If no audiences are provided, the audience will default to the audience of the Kubernetes apiserver. |
tokenstring | Token is the opaque bearer token. |
| Field | Description |
|---|---|
audiencesstring array | Audiences are audience identifiers chosen by the authenticator that are compatible with both the TokenReview and token. An identifier is any identifier in the intersection of the TokenReviewSpec audiences and the token's audiences. A client of the TokenReview API that sets the spec.audiences field should validate that a compatible audience identifier is returned in the status.audiences field to ensure that the TokenReview server is audience aware. If a TokenReview returns an empty status.audience field where status.authenticated is "true", the token is valid against the audience of the Kubernetes API server. |
authenticatedboolean | Authenticated indicates that the token was associated with a known user. |
errorstring | Error indicates that the token couldn't be checked |
userUserInfo | User is the UserInfo associated with the provided token. |
create a TokenReview
+POST /apis/authentication.k8s.io/v1beta1/tokenreviews
+| Parameter | Description |
|---|---|
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
includeUninitialized | If IncludeUninitialized is specified, the object may be returned without completing initialization. |
pretty | If 'true', then the output is pretty printed. |
| Parameter | Description |
|---|---|
bodyTokenReview |
| Code | Description |
|---|---|
| 202 TokenReview | Accepted |
| 200 TokenReview | OK |
| 201 TokenReview | Created |
| Group | Version | Kind |
|---|---|---|
authentication.k8s.io | v1beta1 | UserInfo |
| Field | Description |
|---|---|
extraobject | Any additional information provided by the authenticator. |
groupsstring array | The names of groups this user is a part of. |
uidstring | 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. |
usernamestring | The name that uniquely identifies this user among all active users. |
| Group | Version | Kind |
|---|---|---|
storage.k8s.io | v1beta1 | VolumeAttachment |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
specVolumeAttachmentSpec | Specification of the desired attach/detach volume behavior. Populated by the Kubernetes system. |
statusVolumeAttachmentStatus | Status of the VolumeAttachment request. Populated by the entity completing the attach or detach operation, i.e. the external-attacher. |
| Field | Description |
|---|---|
attacherstring | Attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName(). |
nodeNamestring | The node that the volume should be attached to. |
sourceVolumeAttachmentSource | Source represents the volume that should be attached. |
| Field | Description |
|---|---|
attachErrorVolumeError | 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. |
attachedboolean | Indicates the volume is successfully attached. This field must only be set by the entity completing the attach operation, i.e. the external-attacher. |
attachmentMetadataobject | 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. |
detachErrorVolumeError | 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. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsVolumeAttachment array | Items is the list of VolumeAttachments |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
create a VolumeAttachment
+POST /apis/storage.k8s.io/v1beta1/volumeattachments
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyVolumeAttachment |
| Code | Description |
|---|---|
| 202 VolumeAttachment | Accepted |
| 200 VolumeAttachment | OK |
| 201 VolumeAttachment | Created |
partially update the specified VolumeAttachment
+PATCH /apis/storage.k8s.io/v1beta1/volumeattachments/{name}
+| Parameter | Description |
|---|---|
name | name of the VolumeAttachment |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 VolumeAttachment | OK |
replace the specified VolumeAttachment
+PUT /apis/storage.k8s.io/v1beta1/volumeattachments/{name}
+| Parameter | Description |
|---|---|
name | name of the VolumeAttachment |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyVolumeAttachment |
| Code | Description |
|---|---|
| 200 VolumeAttachment | OK |
| 201 VolumeAttachment | Created |
delete a VolumeAttachment
+DELETE /apis/storage.k8s.io/v1beta1/volumeattachments/{name}
+| Parameter | Description |
|---|---|
name | name of the VolumeAttachment |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 202 Status | Accepted |
| 200 Status | OK |
delete collection of VolumeAttachment
+DELETE /apis/storage.k8s.io/v1beta1/volumeattachments
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified VolumeAttachment
+GET /apis/storage.k8s.io/v1beta1/volumeattachments/{name}
+| Parameter | Description |
|---|---|
name | name of the VolumeAttachment |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 VolumeAttachment | OK |
list or watch objects of kind VolumeAttachment
+GET /apis/storage.k8s.io/v1beta1/volumeattachments
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 VolumeAttachmentList | OK |
watch changes to an object of kind VolumeAttachment. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/storage.k8s.io/v1beta1/watch/volumeattachments/{name}
+| Parameter | Description |
|---|---|
name | name of the VolumeAttachment |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of VolumeAttachment. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/storage.k8s.io/v1beta1/watch/volumeattachments
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
storage.k8s.io | v1alpha1 | VolumeAttachment |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
specVolumeAttachmentSpec | Specification of the desired attach/detach volume behavior. Populated by the Kubernetes system. |
statusVolumeAttachmentStatus | Status of the VolumeAttachment request. Populated by the entity completing the attach or detach operation, i.e. the external-attacher. |
| Field | Description |
|---|---|
attacherstring | Attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName(). |
nodeNamestring | The node that the volume should be attached to. |
sourceVolumeAttachmentSource | Source represents the volume that should be attached. |
| Field | Description |
|---|---|
attachErrorVolumeError | 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. |
attachedboolean | Indicates the volume is successfully attached. This field must only be set by the entity completing the attach operation, i.e. the external-attacher. |
attachmentMetadataobject | 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. |
detachErrorVolumeError | 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. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
itemsVolumeAttachment array | Items is the list of VolumeAttachments |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
create a VolumeAttachment
+POST /apis/storage.k8s.io/v1alpha1/volumeattachments
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyVolumeAttachment |
| Code | Description |
|---|---|
| 200 VolumeAttachment | OK |
| 201 VolumeAttachment | Created |
| 202 VolumeAttachment | Accepted |
partially update the specified VolumeAttachment
+PATCH /apis/storage.k8s.io/v1alpha1/volumeattachments/{name}
+| Parameter | Description |
|---|---|
name | name of the VolumeAttachment |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 VolumeAttachment | OK |
replace the specified VolumeAttachment
+PUT /apis/storage.k8s.io/v1alpha1/volumeattachments/{name}
+| Parameter | Description |
|---|---|
name | name of the VolumeAttachment |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| Parameter | Description |
|---|---|
bodyVolumeAttachment |
| Code | Description |
|---|---|
| 201 VolumeAttachment | Created |
| 200 VolumeAttachment | OK |
delete a VolumeAttachment
+DELETE /apis/storage.k8s.io/v1alpha1/volumeattachments/{name}
+| Parameter | Description |
|---|---|
name | name of the VolumeAttachment |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of VolumeAttachment
+DELETE /apis/storage.k8s.io/v1alpha1/volumeattachments
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified VolumeAttachment
+GET /apis/storage.k8s.io/v1alpha1/volumeattachments/{name}
+| Parameter | Description |
|---|---|
name | name of the VolumeAttachment |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export | Should this value be exported. Export strips fields that a user can not specify. |
| Code | Description |
|---|---|
| 200 VolumeAttachment | OK |
list or watch objects of kind VolumeAttachment
+GET /apis/storage.k8s.io/v1alpha1/volumeattachments
+| Parameter | Description |
|---|---|
includeUninitialized | If true, partially initialized resources are included in the response. |
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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
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. |
| Code | Description |
|---|---|
| 200 VolumeAttachmentList | OK |
watch changes to an object of kind VolumeAttachment. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
+GET /apis/storage.k8s.io/v1alpha1/watch/volumeattachments/{name}
+| Parameter | Description |
|---|---|
name | name of the VolumeAttachment |
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of VolumeAttachment. deprecated: use the 'watch' parameter with a list operation instead.
+GET /apis/storage.k8s.io/v1alpha1/watch/volumeattachments
+| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
storage.k8s.io | v1beta1 | VolumeAttachmentSource |
| Field | Description |
|---|---|
persistentVolumeNamestring | Name of the persistent volume to attach. |
| Group | Version | Kind |
|---|---|---|
storage.k8s.io | v1alpha1 | VolumeAttachmentSource |
| Field | Description |
|---|---|
persistentVolumeNamestring | Name of the persistent volume to attach. |
| Group | Version | Kind |
|---|---|---|
storage.k8s.io | v1beta1 | VolumeError |
| Field | Description |
|---|---|
messagestring | String detailing the error encountered during Attach or Detach operation. This string maybe logged, so it should not contain sensitive information. |
timeTime | Time the error was encountered. |
| Group | Version | Kind |
|---|---|---|
storage.k8s.io | v1alpha1 | VolumeError |
| Field | Description |
|---|---|
messagestring | String detailing the error encountered during Attach or Detach operation. This string maybe logged, so it should not contain sensitive information. |
timeTime | Time the error was encountered. |
| Group | Version | Kind |
|---|---|---|
auditregistration.k8s.io | v1alpha1 | Webhook |
| Field | Description |
|---|---|
clientConfigWebhookClientConfig | ClientConfig holds the connection parameters for the webhook required |
throttleWebhookThrottleConfig | Throttle holds the options for throttling the webhook |
| Group | Version | Kind |
|---|---|---|
apiextensions.k8s.io | v1beta1 | WebhookClientConfig |
| Field | Description |
|---|---|
caBundlestring | `caBundle` is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. If unspecified, system trust roots on the apiserver are used. |
serviceServiceReference | `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`. Port 443 will be used if it is open, otherwise it is an error. |
urlstring | `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. |
| Group | Version | Kind |
|---|---|---|
auditregistration.k8s.io | v1alpha1 | WebhookClientConfig |
| Field | Description |
|---|---|
caBundlestring | `caBundle` is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. If unspecified, system trust roots on the apiserver are used. |
serviceServiceReference | `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`. Port 443 will be used if it is open, otherwise it is an error. |
urlstring | `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. |