- kubectl
- curl

# API OVERVIEW

Welcome to the Kubernetes API. You can use the Kubernetes API to read and write Kubernetes resource objects via a Kubernetes API endpoint.

## Resource Categories

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

Resource objects typically have 3 components:

- ResourceSpec: This is defined by the user and describes the desired state of system. Fill this in when creating or updating an object.
- ResourceStatus: This is filled in by the server and reports the current state of the system. Only kubernetes components should fill this in
- Resource ObjectMeta: This is metadata about the resource, such as its name, type, api version, annotations, and labels. This contains fields that maybe updated both by the end user and the system (e.g. annotations)

## Resource Operations

Most resources provide the following Operations:

#### Create:

Create operations will create the resource in the storage backend. After a resource is create the system will apply the desired state.

#### Update:

Updates come in 2 forms: Replace and Patch

Replace: Replacing a resource object will update the resource by replacing the existing spec with the provided one. For read-then-write operations this is safe because an optimistic lock failure will occur if the resource was modified between the read and write. Note: The ResourceStatus will be ignored by the system and will not be updated. To update the status, one must invoke the specific status update operation.

Note: Replacing a resource object may not result immediately in changes being propagated to downstream objects. For instance replacing a ConfigMap or Secret resource will not result in all Pods seeing the changes unless the Pods are restarted out of band.

Patch: Patch will apply a change to a specific field. How the change is merged is defined per field. Lists may either be replaced or merged. Merging lists will not preserve ordering.

Patches will never cause optimistic locking failures, and the last write will win. Patches are recommended when the full state is not read before an update, or when failing on optimistic locking is undesirable. When patching complex types, arrays and maps, how the patch is applied is defined on a per-field basis and may either replace the field's current value, or merge the contents into the current value.

#### Read

Reads come in 3 forms: Get, List and Watch

Get: Get will retrieve a specific resource object by name.

List: List will retrieve all resource objects of a specific type within a namespace, and the results can be restricted to resources matching a selector query.

List All Namespaces: Like List but retrieves resources across all namespaces.

Watch: Watch will stream results for an object(s) as it is updated. Similar to a callback, watch is used to respond to resource changes.

#### Delete

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.

#### Additional Operations

Resources may define additional operations specific to that resource type.

Rollback: Rollback a PodTemplate to a previous version. Only available for some resource types.

Read / Write Scale: Read or Update the number of replicas for the given resource. Only available for some resource types.

Read / Write Status: Read or Update the Status for a resource object. The Status can only changed through these update operations.

# WORKLOADS

Worloads resources are responsible for managing and running your containers on the cluster. Containers are created by Controllers through Pods. Pods run Containers and provide environmental dependencies such as shared or persistent storage Volumes and Configuration or Secret data injected into the container.

The most common Controllers are:

- Deployments for stateless persistent apps (e.g. http servers)
- StatefulSets for stateful persistent apps (e.g. databases)
- Jobs for run-to-completion apps (e.g. batch jobs).

# Container v1 core

> Container Config to run nginx (must be embedded in a PodSpec to run).

    name: nginx
    # Run the nginx:1.10 image
    image: nginx:1.10

> Container Config to run nginx (must be embedded in a PodSpec to run).

    name: nginx
    # Run the nginx:1.10 image
    image: nginx:1.10

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `Container`

Containers are only ever created within the context of a Pod. This is usually done using a Controller. See Controllers: Deployment, Job, or StatefulSet

A single application container that you want to run within a pod.

Appears In:

- PodSpec core/v1

Field | Description
--- | ---
`args` string 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
`command` string 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
`env` EnvVar array patch type: merge patch merge key: name | List of environment variables to set in the container. Cannot be updated.
`envFrom` EnvFromSource 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.
`image` string | 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.
`imagePullPolicy` string | 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
`lifecycle` Lifecycle | Actions that the management system should take in response to container lifecycle events. Cannot be updated.
`livenessProbe` Probe | 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
`name` string | Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
`ports` ContainerPort array patch type: 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.
`readinessProbe` Probe | 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
`resources` ResourceRequirements | Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
`securityContext` SecurityContext | 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/
`stdin` boolean | 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.
`stdinOnce` boolean | 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
`terminationMessagePath` string | 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.
`terminationMessagePolicy` string | 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.
`tty` boolean | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
`volumeDevices` VolumeDevice array patch type: merge patch merge key: devicePath | volumeDevices is the list of block devices to be used by the container. This is an alpha feature and may change in the future.
`volumeMounts` VolumeMount array patch type: merge patch merge key: mountPath | Pod volumes to mount into the container's filesystem. Cannot be updated.
`workingDir` string | 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.

### ContainerStatus v1 core

Appears In:

- PodStatus core/v1

Field | Description
--- | ---
`containerID` string | Container's ID in the format 'docker://<container_id>'.
`image` string | The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images
`imageID` string | ImageID of the container's image.
`lastState` ContainerState | Details about the container's last termination condition.
`name` string | This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated.
`ready` boolean | Specifies whether the container has passed its readiness probe.
`restartCount` integer | 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.
`state` ContainerState | Details about the container's current condition.

# CronJob v1beta1 batch

Group | Version | Kind
--- | --- | ---
`batch` | `v1beta1` | `CronJob`

Other api versions of this object exist: v2alpha1

CronJob represents the configuration of a single cron job.

Appears In:

- CronJobList batch/v1beta1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`spec` CronJobSpec | 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
`status` CronJobStatus | Current status of a cron job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

### CronJobSpec v1beta1 batch

Appears In:

- CronJob batch/v1beta1

Field | Description
--- | ---
`concurrencyPolicy` string | 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
`failedJobsHistoryLimit` integer | The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
`jobTemplate` JobTemplateSpec | Specifies the job that will be created when executing a CronJob.
`schedule` string | The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
`startingDeadlineSeconds` integer | 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.
`successfulJobsHistoryLimit` integer | The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 3.
`suspend` boolean | This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.

### CronJobStatus v1beta1 batch

Appears In:

- CronJob batch/v1beta1

Field | Description
--- | ---
`active` ObjectReference array | A list of pointers to currently running jobs.
`lastScheduleTime` Time | Information when was the last time the job was successfully scheduled.

### CronJobList v1beta1 batch

Field | Description
--- | ---
`apiVersion` string | 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
`items` CronJob array | items is the list of CronJobs.
`kind` string | 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
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a CronJob

### HTTP Request

`POST /apis/batch/v1beta1/namespaces/{namespace}/cronjobs`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` CronJob |

### Response

Code | Description
--- | ---
201 CronJob | Created
202 CronJob | Accepted
200 CronJob | OK

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified CronJob

### HTTP Request

`PATCH /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CronJob
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 CronJob | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified CronJob

### HTTP Request

`PUT /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CronJob
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` CronJob |

### Response

Code | Description
--- | ---
200 CronJob | OK
201 CronJob | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a CronJob

### HTTP Request

`DELETE /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CronJob
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of CronJob

### HTTP Request

`DELETE /apis/batch/v1beta1/namespaces/{namespace}/cronjobs`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified CronJob

### HTTP Request

`GET /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CronJob
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Response

Code | Description
--- | ---
200 CronJob | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind CronJob

### HTTP Request

`GET /apis/batch/v1beta1/namespaces/{namespace}/cronjobs`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 CronJobList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind CronJob

### HTTP Request

`GET /apis/batch/v1beta1/cronjobs`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 CronJobList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind CronJob

### HTTP Request

`GET /apis/batch/v1beta1/watch/namespaces/{namespace}/cronjobs/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CronJob
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of CronJob

### HTTP Request

`GET /apis/batch/v1beta1/watch/namespaces/{namespace}/cronjobs`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of CronJob

### HTTP Request

`GET /apis/batch/v1beta1/watch/cronjobs`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Status Operations

See supported operations below...

## Patch Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update status of the specified CronJob

### HTTP Request

`PATCH /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CronJob
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 CronJob | OK

## Read Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read status of the specified CronJob

### HTTP Request

`GET /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CronJob
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 CronJob | OK

## Replace Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace status of the specified CronJob

### HTTP Request

`PUT /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CronJob
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` CronJob |

### Response

Code | Description
--- | ---
201 CronJob | Created
200 CronJob | OK

# DaemonSet v1 apps

> DaemonSet Config to print the `hostname` on each Node in the cluster every 10 seconds.

    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

> DaemonSet Config to print the `hostname` on each Node in the cluster every 10 seconds.

    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`

Other api versions of this object exist: v1beta2 v1beta1

DaemonSet represents the configuration of a daemon set.

Appears In:

- DaemonSetList apps/v1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`spec` DaemonSetSpec | The desired behavior of this daemon set. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
`status` DaemonSetStatus | 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

### DaemonSetSpec v1 apps

Appears In:

- DaemonSet apps/v1

Field | Description
--- | ---
`minReadySeconds` integer | 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).
`revisionHistoryLimit` integer | 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.
`selector` LabelSelector | 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
`template` PodTemplateSpec | 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
`updateStrategy` DaemonSetUpdateStrategy | An update strategy to replace existing DaemonSet pods with new pods.

### DaemonSetStatus v1 apps

Appears In:

- DaemonSet apps/v1

Field | Description
--- | ---
`collisionCount` integer | 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.
`conditions` DaemonSetCondition array patch type: merge patch merge key: type | Represents the latest available observations of a DaemonSet's current state.
`currentNumberScheduled` integer | 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/
`desiredNumberScheduled` integer | 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/
`numberAvailable` integer | 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)
`numberMisscheduled` integer | 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/
`numberReady` integer | The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready.
`numberUnavailable` integer | 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)
`observedGeneration` integer | The most recent generation observed by the daemon set controller.
`updatedNumberScheduled` integer | The total number of nodes that are running updated daemon pod

### DaemonSetList v1 apps

Field | Description
--- | ---
`apiVersion` string | 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
`items` DaemonSet array | A list of daemon sets.
`kind` string | 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
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

### RollingUpdateDaemonSet v1 apps

Appears In:

- DaemonSetUpdateStrategy apps/v1

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.

## Write Operations

See supported operations below...

## Create

> `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

> Output

    daemonset "daemonset-example" created

> Response Body

    {
      "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

### HTTP Request

`POST /apis/apps/v1/namespaces/{namespace}/daemonsets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` DaemonSet |

### Response

Code | Description
--- | ---
200 DaemonSet | OK
201 DaemonSet | Created
202 DaemonSet | Accepted

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified DaemonSet

### HTTP Request

`PATCH /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the DaemonSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 DaemonSet | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified DaemonSet

### HTTP Request

`PUT /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the DaemonSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` DaemonSet |

### Response

Code | Description
--- | ---
200 DaemonSet | OK
201 DaemonSet | Created

## Delete

> `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'

> Output

    daemonset "daemonset-example" deleted

> Response Body

    {
      "kind": "Status",
      "apiVersion": "v1",
      "metadata": {},
      "status": "Success",
      "code": 200
    }

delete a DaemonSet

### HTTP Request

`DELETE /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the DaemonSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of DaemonSet

### HTTP Request

`DELETE /apis/apps/v1/namespaces/{namespace}/daemonsets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `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

> Output

> Response Body

read the specified DaemonSet

### HTTP Request

`GET /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the DaemonSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Response

Code | Description
--- | ---
200 DaemonSet | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind DaemonSet

### HTTP Request

`GET /apis/apps/v1/namespaces/{namespace}/daemonsets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 DaemonSetList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind DaemonSet

### HTTP Request

`GET /apis/apps/v1/daemonsets`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 DaemonSetList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind DaemonSet

### HTTP Request

`GET /apis/apps/v1/watch/namespaces/{namespace}/daemonsets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the DaemonSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of DaemonSet

### HTTP Request

`GET /apis/apps/v1/watch/namespaces/{namespace}/daemonsets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of DaemonSet

### HTTP Request

`GET /apis/apps/v1/watch/daemonsets`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Status Operations

See supported operations below...

## Patch Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update status of the specified DaemonSet

### HTTP Request

`PATCH /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the DaemonSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 DaemonSet | OK

## Read Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read status of the specified DaemonSet

### HTTP Request

`GET /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the DaemonSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 DaemonSet | OK

## Replace Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace status of the specified DaemonSet

### HTTP Request

`PUT /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the DaemonSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` DaemonSet |

### Response

Code | Description
--- | ---
201 DaemonSet | Created
200 DaemonSet | OK

# Deployment v1 apps

> Deployment Config to run 3 nginx instances (max rollback set to 10 revisions).

    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

> Deployment Config to run 3 nginx instances (max rollback set to 10 revisions).

    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`

Other api versions of this object exist: v1beta2 v1beta1 v1beta1

Deployment enables declarative updates for Pods and ReplicaSets.

Appears In:

- DeploymentList apps/v1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object metadata.
`spec` DeploymentSpec | Specification of the desired behavior of the Deployment.
`status` DeploymentStatus | Most recently observed status of the Deployment.

### DeploymentSpec v1 apps

Appears In:

- Deployment apps/v1

Field | Description
--- | ---
`minReadySeconds` integer | Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
`paused` boolean | Indicates that the deployment is paused.
`progressDeadlineSeconds` integer | The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s.
`replicas` integer | Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
`revisionHistoryLimit` integer | The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.
`selector` LabelSelector | 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.
`strategy` DeploymentStrategy | The deployment strategy to use to replace existing pods with new ones.
`template` PodTemplateSpec | Template describes the pods that will be created.

### DeploymentStatus v1 apps

Appears In:

- Deployment apps/v1

Field | Description
--- | ---
`availableReplicas` integer | Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.
`collisionCount` integer | Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet.
`conditions` DeploymentCondition array patch type: merge patch merge key: type | Represents the latest available observations of a deployment's current state.
`observedGeneration` integer | The generation observed by the deployment controller.
`readyReplicas` integer | Total number of ready pods targeted by this deployment.
`replicas` integer | Total number of non-terminated pods targeted by this deployment (their labels match the selector).
`unavailableReplicas` integer | Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created.
`updatedReplicas` integer | Total number of non-terminated pods targeted by this deployment that have the desired template spec.

### DeploymentList v1 apps

Field | Description
--- | ---
`apiVersion` string | 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
`items` Deployment array | Items is the list of Deployments.
`kind` string | 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
`metadata` ListMeta | Standard list metadata.

### DeploymentStrategy v1 apps

Appears In:

- DeploymentSpec apps/v1

Field | Description
--- | ---
`rollingUpdate` RollingUpdateDeployment | Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate.
`type` string | Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.

### RollingUpdateDeployment v1 apps

Appears In:

- DeploymentStrategy apps/v1

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 RC can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new RC can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods.
`maxUnavailable` | 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 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.

## Write Operations

See supported operations below...

## Create

> `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

> Output

    deployment "deployment-example" created

> Response Body

    {
      "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

### HTTP Request

`POST /apis/apps/v1/namespaces/{namespace}/deployments`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Deployment |

### Response

Code | Description
--- | ---
200 Deployment | OK
201 Deployment | Created
202 Deployment | Accepted

## Patch

> `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'

> Output

    "deployment-example" patched

> Response Body

    {
      "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

### HTTP Request

`PATCH /apis/apps/v1/namespaces/{namespace}/deployments/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Deployment
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 Deployment | OK

## Replace

> `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

> Output

    deployment "deployment-example" replaced

> Response Body

    {
      "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

### HTTP Request

`PUT /apis/apps/v1/namespaces/{namespace}/deployments/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Deployment
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Deployment |

### Response

Code | Description
--- | ---
200 Deployment | OK
201 Deployment | Created

## Delete

> `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'

> Output

    deployment "deployment-example" deleted

> Response Body

    {
      "kind": "Status",
      "apiVersion": "v1",
      "metadata": {},
      "status": "Success",
      "code": 200
    }

delete a Deployment

### HTTP Request

`DELETE /apis/apps/v1/namespaces/{namespace}/deployments/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Deployment
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of Deployment

### HTTP Request

`DELETE /apis/apps/v1/namespaces/{namespace}/deployments`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    $ kubectl get deployment deployment-example -o json

> `curl` Command (requires `kubectl proxy` to be running)

    $ kubectl proxy
    $ curl -X GET http://127.0.0.1:8001/apis/apps/v1/namespaces/default/deployments/deployment-example

> Output

    {
      "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
      }
    }

> Response Body

    {
      "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

### HTTP Request

`GET /apis/apps/v1/namespaces/{namespace}/deployments/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Deployment
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`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.

### Response

Code | Description
--- | ---
200 Deployment | OK

## List

> `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'

> Output

    {
      "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
          }
        }
      ]
    }

> Response Body

    {
      "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

### HTTP Request

`GET /apis/apps/v1/namespaces/{namespace}/deployments`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 DeploymentList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind Deployment

### HTTP Request

`GET /apis/apps/v1/deployments`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 DeploymentList | OK

## Watch

> `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'

> Output

    {
        "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
            }
        }
    }

> Response Body

    {
        "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

### HTTP Request

`GET /apis/apps/v1/watch/namespaces/{namespace}/deployments/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Deployment
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of Deployment

### HTTP Request

`GET /apis/apps/v1/watch/namespaces/{namespace}/deployments`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of Deployment

### HTTP Request

`GET /apis/apps/v1/watch/deployments`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Status Operations

See supported operations below...

## Patch Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update status of the specified Deployment

### HTTP Request

`PATCH /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Deployment
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 Deployment | OK

## Read Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read status of the specified Deployment

### HTTP Request

`GET /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Deployment
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 Deployment | OK

## Replace Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace status of the specified Deployment

### HTTP Request

`PUT /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Deployment
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Deployment |

### Response

Code | Description
--- | ---
200 Deployment | OK
201 Deployment | Created

## Misc Operations

See supported operations below...

## Read Scale

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read scale of the specified Deployment

### HTTP Request

`GET /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Scale
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 Scale | OK

## Replace Scale

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace scale of the specified Deployment

### HTTP Request

`PUT /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Scale
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Scale |

### Response

Code | Description
--- | ---
200 Scale | OK
201 Scale | Created

## Patch Scale

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update scale of the specified Deployment

### HTTP Request

`PATCH /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Scale
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 Scale | OK

# Job v1 batch

> Job Config to print pi up to 2000 digits (then exit).

    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

> Job Config to print pi up to 2000 digits (then exit).

    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`

Job represents the configuration of a single job.

Appears In:

- JobList batch/v1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`spec` JobSpec | Specification of the desired behavior of a job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
`status` JobStatus | Current status of a job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

### JobSpec v1 batch

Appears In:

- Job batch/v1
- JobTemplateSpec batch/v1beta1
- JobTemplateSpec batch/v2alpha1

Field | Description
--- | ---
`activeDeadlineSeconds` integer | 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
`backoffLimit` integer | Specifies the number of retries before marking this job failed. Defaults to 6
`completions` integer | 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/
`manualSelector` boolean | 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
`parallelism` integer | 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/
`selector` LabelSelector | 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
`template` PodTemplateSpec | Describes the pod that will be created when executing a job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/

### JobStatus v1 batch

Appears In:

- Job batch/v1

Field | Description
--- | ---
`active` integer | The number of actively running pods.
`completionTime` Time | 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.
`conditions` JobCondition array patch type: 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/
`failed` integer | The number of pods which reached phase Failed.
`startTime` Time | 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.
`succeeded` integer | The number of pods which reached phase Succeeded.

### JobList v1 batch

Field | Description
--- | ---
`apiVersion` string | 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
`items` Job array | items is the list of Jobs.
`kind` string | 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
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

## Write Operations

See supported operations below...

## Create

> `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

> Output

    job "example-job" created

> Response Body

    {
      "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

### HTTP Request

`POST /apis/batch/v1/namespaces/{namespace}/jobs`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Job |

### Response

Code | Description
--- | ---
200 Job | OK
201 Job | Created
202 Job | Accepted

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified Job

### HTTP Request

`PATCH /apis/batch/v1/namespaces/{namespace}/jobs/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Job
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 Job | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified Job

### HTTP Request

`PUT /apis/batch/v1/namespaces/{namespace}/jobs/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Job
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Job |

### Response

Code | Description
--- | ---
200 Job | OK
201 Job | Created

## Delete

> `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'

> Output

    job "example-job" deleted

> Response Body

    {
      "kind": "Status",
      "apiVersion": "v1",
      "metadata": {},
      "status": "Success",
      "code": 200
    }

delete a Job

### HTTP Request

`DELETE /apis/batch/v1/namespaces/{namespace}/jobs/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Job
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of Job

### HTTP Request

`DELETE /apis/batch/v1/namespaces/{namespace}/jobs`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `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

> Output

    {
      "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
      }
    }

> Response Body

    {
      "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

### HTTP Request

`GET /apis/batch/v1/namespaces/{namespace}/jobs/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Job
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Response

Code | Description
--- | ---
200 Job | OK

## List

> `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'

> Output

    {
      "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
          }
        }
      ]
    }

> Response Body

    {
      "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

### HTTP Request

`GET /apis/batch/v1/namespaces/{namespace}/jobs`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 JobList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind Job

### HTTP Request

`GET /apis/batch/v1/jobs`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 JobList | OK

## Watch

> `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'

> Output

    {
        "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
            }
        }
    }

> Response Body

    {
        "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

### HTTP Request

`GET /apis/batch/v1/watch/namespaces/{namespace}/jobs/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Job
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of Job

### HTTP Request

`GET /apis/batch/v1/watch/namespaces/{namespace}/jobs`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of Job

### HTTP Request

`GET /apis/batch/v1/watch/jobs`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Status Operations

See supported operations below...

## Patch Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update status of the specified Job

### HTTP Request

`PATCH /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Job
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 Job | OK

## Read Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read status of the specified Job

### HTTP Request

`GET /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Job
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 Job | OK

## Replace Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace status of the specified Job

### HTTP Request

`PUT /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Job
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Job |

### Response

Code | Description
--- | ---
200 Job | OK
201 Job | Created

# Pod v1 core

> Pod Config to print "Hello World".

    apiVersion: v1
    kind: Pod
    metadata:
      name: pod-example
    spec:
      containers:
      - name: ubuntu
        image: ubuntu:trusty
        command: ["echo"]
        args: ["Hello World"]

> Pod Config to print "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`

It is recommended that users create Pods only through a Controller, and not directly. See Controllers: Deployment, Job, or StatefulSet.

Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts.

Appears In:

- PodList core/v1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`spec` PodSpec | Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
`status` PodStatus | 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

### PodSpec v1 core

Appears In:

- Pod core/v1
- PodTemplateSpec core/v1

Field | Description
--- | ---
`activeDeadlineSeconds` integer | 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.
`affinity` Affinity | If specified, the pod's scheduling constraints
`automountServiceAccountToken` boolean | AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.
`containers` Container array patch type: 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.
`dnsConfig` PodDNSConfig | Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.
`dnsPolicy` string | Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.
`hostAliases` HostAlias array patch type: 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.
`hostIPC` boolean | Use the host's ipc namespace. Optional: Default to false.
`hostNetwork` boolean | 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.
`hostPID` boolean | Use the host's pid namespace. Optional: Default to false.
`hostname` string | Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value.
`imagePullSecrets` LocalObjectReference array patch type: 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
`initContainers` Container array patch type: 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/
`nodeName` string | 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.
`nodeSelector` object | 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/
`priority` integer | 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.
`priorityClassName` string | 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.
`restartPolicy` string | 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
`schedulerName` string | If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.
`securityContext` PodSecurityContext | SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.
`serviceAccount` string | DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.
`serviceAccountName` string | 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/
`shareProcessNamespace` boolean | Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false. This field is alpha-level and is honored only by servers that enable the PodShareProcessNamespace feature.
`subdomain` string | If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". If not specified, the pod will not have a domainname at all.
`terminationGracePeriodSeconds` integer | 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.
`tolerations` Toleration array | If specified, the pod's tolerations.
`volumes` Volume array patch type: 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

### PodStatus v1 core

Appears In:

- Pod core/v1

Field | Description
--- | ---
`conditions` PodCondition array patch type: merge patch merge key: type | Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
`containerStatuses` ContainerStatus 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
`hostIP` string | IP address of the host to which the pod is assigned. Empty if not yet scheduled.
`initContainerStatuses` ContainerStatus 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
`message` string | A human readable message indicating details about why the pod is in this condition.
`nominatedNodeName` string | nominatedNodeName is set only when this pod preempts other pods on the node, but it cannot be scheduled right away as preemption victims receive their graceful termination periods. This field does not guarantee that the pod will be scheduled on this node. Scheduler may decide to place the pod elsewhere if other nodes become available sooner. Scheduler may also decide to give the resources on this node to a higher priority pod that is created after preemption. As a result, this field may be different than PodSpec.nodeName when the pod is scheduled.
`phase` string | Current condition of the pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase
`podIP` string | IP address allocated to the pod. Routable at least within the cluster. Empty if not yet allocated.
`qosClass` string | 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
`reason` string | A brief CamelCase message indicating details about why the pod is in this state. e.g. 'Evicted'
`startTime` Time | 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.

### PodList v1 core

Field | Description
--- | ---
`apiVersion` string | 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
`items` Pod array | List of pods. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md
`kind` string | 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
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a Pod

### HTTP Request

`POST /api/v1/namespaces/{namespace}/pods`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Pod |

### Response

Code | Description
--- | ---
200 Pod | OK
201 Pod | Created
202 Pod | Accepted

## Create Eviction

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create eviction of a Pod

### HTTP Request

`POST /api/v1/namespaces/{namespace}/pods/{name}/eviction`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Eviction
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Eviction |

### Response

Code | Description
--- | ---
201 Eviction | Created
202 Eviction | Accepted
200 Eviction | OK

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified Pod

### HTTP Request

`PATCH /api/v1/namespaces/{namespace}/pods/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Pod
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 Pod | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified Pod

### HTTP Request

`PUT /api/v1/namespaces/{namespace}/pods/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Pod
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Pod |

### Response

Code | Description
--- | ---
200 Pod | OK
201 Pod | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a Pod

### HTTP Request

`DELETE /api/v1/namespaces/{namespace}/pods/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Pod
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of Pod

### HTTP Request

`DELETE /api/v1/namespaces/{namespace}/pods`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified Pod

### HTTP Request

`GET /api/v1/namespaces/{namespace}/pods/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Pod
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Response

Code | Description
--- | ---
200 Pod | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind Pod

### HTTP Request

`GET /api/v1/namespaces/{namespace}/pods`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 PodList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind Pod

### HTTP Request

`GET /api/v1/pods`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 PodList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind Pod

### HTTP Request

`GET /api/v1/watch/namespaces/{namespace}/pods/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Pod
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of Pod

### HTTP Request

`GET /api/v1/watch/namespaces/{namespace}/pods`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of Pod

### HTTP Request

`GET /api/v1/watch/pods`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Status Operations

See supported operations below...

## Patch Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update status of the specified Pod

### HTTP Request

`PATCH /api/v1/namespaces/{namespace}/pods/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Pod
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 Pod | OK

## Read Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read status of the specified Pod

### HTTP Request

`GET /api/v1/namespaces/{namespace}/pods/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Pod
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 Pod | OK

## Replace Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace status of the specified Pod

### HTTP Request

`PUT /api/v1/namespaces/{namespace}/pods/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Pod
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Pod |

### Response

Code | Description
--- | ---
200 Pod | OK
201 Pod | Created

## Proxy Operations

See supported operations below...

## Create Connect Portforward

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

connect POST requests to portforward of Pod

### HTTP Request

`POST /api/v1/namespaces/{namespace}/pods/{name}/portforward`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Pod
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`ports` | List of ports to forward Required when using WebSockets

### Response

Code | Description
--- | ---
200 string | OK

## Create Connect Proxy

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

connect POST requests to proxy of Pod

### HTTP Request

`POST /api/v1/namespaces/{namespace}/pods/{name}/proxy`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Pod
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`path` | Path is the URL path to use for the current proxy request to pod.

### Response

Code | Description
--- | ---
200 string | OK

## Create Connect Proxy Path

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

connect POST requests to proxy of Pod

### HTTP Request

`POST /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Pod
`namespace` | object name and auth scope, such as for teams and projects
`path` | path to the resource

### Query Parameters

Parameter | Description
--- | ---
`path` | Path is the URL path to use for the current proxy request to pod.

### Response

Code | Description
--- | ---
200 string | OK

## Delete Connect Proxy

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

connect DELETE requests to proxy of Pod

### HTTP Request

`DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Pod
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`path` | Path is the URL path to use for the current proxy request to pod.

### Response

Code | Description
--- | ---
200 string | OK

## Delete Connect Proxy Path

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

connect DELETE requests to proxy of Pod

### HTTP Request

`DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Pod
`namespace` | object name and auth scope, such as for teams and projects
`path` | path to the resource

### Query Parameters

Parameter | Description
--- | ---
`path` | Path is the URL path to use for the current proxy request to pod.

### Response

Code | Description
--- | ---
200 string | OK

## Get Connect Portforward

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

connect GET requests to portforward of Pod

### HTTP Request

`GET /api/v1/namespaces/{namespace}/pods/{name}/portforward`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Pod
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`ports` | List of ports to forward Required when using WebSockets

### Response

Code | Description
--- | ---
200 string | OK

## Get Connect Proxy

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

connect GET requests to proxy of Pod

### HTTP Request

`GET /api/v1/namespaces/{namespace}/pods/{name}/proxy`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Pod
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`path` | Path is the URL path to use for the current proxy request to pod.

### Response

Code | Description
--- | ---
200 string | OK

## Get Connect Proxy Path

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

connect GET requests to proxy of Pod

### HTTP Request

`GET /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Pod
`namespace` | object name and auth scope, such as for teams and projects
`path` | path to the resource

### Query Parameters

Parameter | Description
--- | ---
`path` | Path is the URL path to use for the current proxy request to pod.

### Response

Code | Description
--- | ---
200 string | OK

## Head Connect Proxy

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

connect HEAD requests to proxy of Pod

### HTTP Request

`HEAD /api/v1/namespaces/{namespace}/pods/{name}/proxy`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Pod
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`path` | Path is the URL path to use for the current proxy request to pod.

### Response

Code | Description
--- | ---
200 string | OK

## Head Connect Proxy Path

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

connect HEAD requests to proxy of Pod

### HTTP Request

`HEAD /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Pod
`namespace` | object name and auth scope, such as for teams and projects
`path` | path to the resource

### Query Parameters

Parameter | Description
--- | ---
`path` | Path is the URL path to use for the current proxy request to pod.

### Response

Code | Description
--- | ---
200 string | OK

## Replace Connect Proxy

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

connect PUT requests to proxy of Pod

### HTTP Request

`PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Pod
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`path` | Path is the URL path to use for the current proxy request to pod.

### Response

Code | Description
--- | ---
200 string | OK

## Replace Connect Proxy Path

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

connect PUT requests to proxy of Pod

### HTTP Request

`PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Pod
`namespace` | object name and auth scope, such as for teams and projects
`path` | path to the resource

### Query Parameters

Parameter | Description
--- | ---
`path` | Path is the URL path to use for the current proxy request to pod.

### Response

Code | Description
--- | ---
200 string | OK

## Misc Operations

See supported operations below...

## Read Log

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read log of the specified Pod

### HTTP Request

`GET /api/v1/namespaces/{namespace}/pods/{name}/log`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Pod
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

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.

### Response

Code | Description
--- | ---
200 string | OK

# ReplicaSet v1 apps

> ReplicaSet Config to run 3 nginx instances.

    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

> ReplicaSet Config to run 3 nginx instances.

    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`

In many cases it is recommended to create a Deployment instead of ReplicaSet.
Other api versions of this object exist: v1beta2 v1beta1

ReplicaSet ensures that a specified number of pod replicas are running at any given time.

Appears In:

- ReplicaSetList apps/v1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | 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
`spec` ReplicaSetSpec | 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
`status` ReplicaSetStatus | 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

### ReplicaSetSpec v1 apps

Appears In:

- ReplicaSet apps/v1

Field | Description
--- | ---
`minReadySeconds` integer | Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
`replicas` integer | 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
`selector` LabelSelector | 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
`template` PodTemplateSpec | 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

### ReplicaSetStatus v1 apps

Appears In:

- ReplicaSet apps/v1

Field | Description
--- | ---
`availableReplicas` integer | The number of available replicas (ready for at least minReadySeconds) for this replica set.
`conditions` ReplicaSetCondition array patch type: merge patch merge key: type | Represents the latest available observations of a replica set's current state.
`fullyLabeledReplicas` integer | The number of pods that have labels matching the labels of the pod template of the replicaset.
`observedGeneration` integer | ObservedGeneration reflects the generation of the most recently observed ReplicaSet.
`readyReplicas` integer | The number of ready replicas for this replica set.
`replicas` integer | Replicas is the most recently oberved number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller

### ReplicaSetList v1 apps

Field | Description
--- | ---
`apiVersion` string | 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
`items` ReplicaSet array | List of ReplicaSets. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller
`kind` string | 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
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a ReplicaSet

### HTTP Request

`POST /apis/apps/v1/namespaces/{namespace}/replicasets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ReplicaSet |

### Response

Code | Description
--- | ---
200 ReplicaSet | OK
201 ReplicaSet | Created
202 ReplicaSet | Accepted

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified ReplicaSet

### HTTP Request

`PATCH /apis/apps/v1/namespaces/{namespace}/replicasets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ReplicaSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 ReplicaSet | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified ReplicaSet

### HTTP Request

`PUT /apis/apps/v1/namespaces/{namespace}/replicasets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ReplicaSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ReplicaSet |

### Response

Code | Description
--- | ---
200 ReplicaSet | OK
201 ReplicaSet | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a ReplicaSet

### HTTP Request

`DELETE /apis/apps/v1/namespaces/{namespace}/replicasets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ReplicaSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of ReplicaSet

### HTTP Request

`DELETE /apis/apps/v1/namespaces/{namespace}/replicasets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified ReplicaSet

### HTTP Request

`GET /apis/apps/v1/namespaces/{namespace}/replicasets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ReplicaSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Response

Code | Description
--- | ---
200 ReplicaSet | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind ReplicaSet

### HTTP Request

`GET /apis/apps/v1/namespaces/{namespace}/replicasets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 ReplicaSetList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind ReplicaSet

### HTTP Request

`GET /apis/apps/v1/replicasets`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 ReplicaSetList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind ReplicaSet

### HTTP Request

`GET /apis/apps/v1/watch/namespaces/{namespace}/replicasets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ReplicaSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of ReplicaSet

### HTTP Request

`GET /apis/apps/v1/watch/namespaces/{namespace}/replicasets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of ReplicaSet

### HTTP Request

`GET /apis/apps/v1/watch/replicasets`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Status Operations

See supported operations below...

## Patch Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update status of the specified ReplicaSet

### HTTP Request

`PATCH /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ReplicaSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 ReplicaSet | OK

## Read Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read status of the specified ReplicaSet

### HTTP Request

`GET /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ReplicaSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 ReplicaSet | OK

## Replace Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace status of the specified ReplicaSet

### HTTP Request

`PUT /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ReplicaSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ReplicaSet |

### Response

Code | Description
--- | ---
200 ReplicaSet | OK
201 ReplicaSet | Created

## Misc Operations

See supported operations below...

## Read Scale

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read scale of the specified ReplicaSet

### HTTP Request

`GET /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Scale
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 Scale | OK

## Replace Scale

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace scale of the specified ReplicaSet

### HTTP Request

`PUT /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Scale
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Scale |

### Response

Code | Description
--- | ---
200 Scale | OK
201 Scale | Created

## Patch Scale

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update scale of the specified ReplicaSet

### HTTP Request

`PATCH /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Scale
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 Scale | OK

# ReplicationController v1 core

> ReplicationController Config to run 3 nginx instances.

    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

> ReplicationController Config to run 3 nginx instances.

    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`

In many cases it is recommended to create a Deployment instead of a ReplicationController.

ReplicationController represents the configuration of a replication controller.

Appears In:

- ReplicationControllerList core/v1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | 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
`spec` ReplicationControllerSpec | 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
`status` ReplicationControllerStatus | 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

### ReplicationControllerSpec v1 core

Appears In:

- ReplicationController core/v1

Field | Description
--- | ---
`minReadySeconds` integer | Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
`replicas` integer | 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
`selector` object | 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
`template` PodTemplateSpec | 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

### ReplicationControllerStatus v1 core

Appears In:

- ReplicationController core/v1

Field | Description
--- | ---
`availableReplicas` integer | The number of available replicas (ready for at least minReadySeconds) for this replication controller.
`conditions` ReplicationControllerCondition array patch type: merge patch merge key: type | Represents the latest available observations of a replication controller's current state.
`fullyLabeledReplicas` integer | The number of pods that have labels matching the labels of the pod template of the replication controller.
`observedGeneration` integer | ObservedGeneration reflects the generation of the most recently observed replication controller.
`readyReplicas` integer | The number of ready replicas for this replication controller.
`replicas` integer | Replicas is the most recently oberved number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller

### ReplicationControllerList v1 core

Field | Description
--- | ---
`apiVersion` string | 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
`items` ReplicationController array | List of replication controllers. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller
`kind` string | 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
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a ReplicationController

### HTTP Request

`POST /api/v1/namespaces/{namespace}/replicationcontrollers`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ReplicationController |

### Response

Code | Description
--- | ---
200 ReplicationController | OK
201 ReplicationController | Created
202 ReplicationController | Accepted

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified ReplicationController

### HTTP Request

`PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ReplicationController
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 ReplicationController | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified ReplicationController

### HTTP Request

`PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ReplicationController
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ReplicationController |

### Response

Code | Description
--- | ---
200 ReplicationController | OK
201 ReplicationController | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a ReplicationController

### HTTP Request

`DELETE /api/v1/namespaces/{namespace}/replicationcontrollers/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ReplicationController
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of ReplicationController

### HTTP Request

`DELETE /api/v1/namespaces/{namespace}/replicationcontrollers`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified ReplicationController

### HTTP Request

`GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ReplicationController
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Response

Code | Description
--- | ---
200 ReplicationController | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind ReplicationController

### HTTP Request

`GET /api/v1/namespaces/{namespace}/replicationcontrollers`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 ReplicationControllerList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind ReplicationController

### HTTP Request

`GET /api/v1/replicationcontrollers`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 ReplicationControllerList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind ReplicationController

### HTTP Request

`GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ReplicationController
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of ReplicationController

### HTTP Request

`GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of ReplicationController

### HTTP Request

`GET /api/v1/watch/replicationcontrollers`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Status Operations

See supported operations below...

## Patch Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update status of the specified ReplicationController

### HTTP Request

`PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ReplicationController
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 ReplicationController | OK

## Read Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read status of the specified ReplicationController

### HTTP Request

`GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ReplicationController
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 ReplicationController | OK

## Replace Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace status of the specified ReplicationController

### HTTP Request

`PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ReplicationController
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ReplicationController |

### Response

Code | Description
--- | ---
200 ReplicationController | OK
201 ReplicationController | Created

## Misc Operations

See supported operations below...

## Read Scale

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read scale of the specified ReplicationController

### HTTP Request

`GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Scale
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 Scale | OK

## Replace Scale

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace scale of the specified ReplicationController

### HTTP Request

`PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Scale
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Scale |

### Response

Code | Description
--- | ---
200 Scale | OK
201 Scale | Created

## Patch Scale

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update scale of the specified ReplicationController

### HTTP Request

`PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Scale
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 Scale | OK

# StatefulSet v1 apps

Group | Version | Kind
--- | --- | ---
`apps` | `v1` | `StatefulSet`

Other api versions of this object exist: v1beta2 v1beta1

StatefulSet represents a set of pods with consistent identities. Identities are defined as:

- Network: A single stable DNS and hostname.
- Storage: As many VolumeClaims as requested. The StatefulSet guarantees that a given network identity will always map to the same storage identity.

Appears In:

- StatefulSetList apps/v1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta |
`spec` StatefulSetSpec | Spec defines the desired identities of pods in this set.
`status` StatefulSetStatus | Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time.

### StatefulSetSpec v1 apps

Appears In:

- StatefulSet apps/v1

Field | Description
--- | ---
`podManagementPolicy` string | podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is `OrderedReady`, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is `Parallel` which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.
`replicas` integer | replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.
`revisionHistoryLimit` integer | revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.
`selector` LabelSelector | 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
`serviceName` string | serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller.
`template` PodTemplateSpec | template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet.
`updateStrategy` StatefulSetUpdateStrategy | updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.
`volumeClaimTemplates` PersistentVolumeClaim 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.

### StatefulSetStatus v1 apps

Appears In:

- StatefulSet apps/v1

Field | Description
--- | ---
`collisionCount` integer | collisionCount is the count of hash collisions for the StatefulSet. The StatefulSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.
`conditions` StatefulSetCondition array patch type: merge patch merge key: type | Represents the latest available observations of a statefulset's current state.
`currentReplicas` integer | currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision.
`currentRevision` string | currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas).
`observedGeneration` integer | observedGeneration is the most recent generation observed for this StatefulSet. It corresponds to the StatefulSet's generation, which is updated on mutation by the API Server.
`readyReplicas` integer | readyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition.
`replicas` integer | replicas is the number of Pods created by the StatefulSet controller.
`updateRevision` string | updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [replicas-updatedReplicas,replicas)
`updatedReplicas` integer | updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision.

### StatefulSetList v1 apps

Field | Description
--- | ---
`apiVersion` string | 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
`items` StatefulSet array |
`kind` string | 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
`metadata` ListMeta |

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a StatefulSet

### HTTP Request

`POST /apis/apps/v1/namespaces/{namespace}/statefulsets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` StatefulSet |

### Response

Code | Description
--- | ---
202 StatefulSet | Accepted
200 StatefulSet | OK
201 StatefulSet | Created

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified StatefulSet

### HTTP Request

`PATCH /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StatefulSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 StatefulSet | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified StatefulSet

### HTTP Request

`PUT /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StatefulSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` StatefulSet |

### Response

Code | Description
--- | ---
200 StatefulSet | OK
201 StatefulSet | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a StatefulSet

### HTTP Request

`DELETE /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StatefulSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of StatefulSet

### HTTP Request

`DELETE /apis/apps/v1/namespaces/{namespace}/statefulsets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified StatefulSet

### HTTP Request

`GET /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StatefulSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Response

Code | Description
--- | ---
200 StatefulSet | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind StatefulSet

### HTTP Request

`GET /apis/apps/v1/namespaces/{namespace}/statefulsets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 StatefulSetList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind StatefulSet

### HTTP Request

`GET /apis/apps/v1/statefulsets`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 StatefulSetList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind StatefulSet

### HTTP Request

`GET /apis/apps/v1/watch/namespaces/{namespace}/statefulsets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StatefulSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of StatefulSet

### HTTP Request

`GET /apis/apps/v1/watch/namespaces/{namespace}/statefulsets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of StatefulSet

### HTTP Request

`GET /apis/apps/v1/watch/statefulsets`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Status Operations

See supported operations below...

## Patch Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update status of the specified StatefulSet

### HTTP Request

`PATCH /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StatefulSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 StatefulSet | OK

## Read Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read status of the specified StatefulSet

### HTTP Request

`GET /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StatefulSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 StatefulSet | OK

## Replace Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace status of the specified StatefulSet

### HTTP Request

`PUT /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StatefulSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` StatefulSet |

### Response

Code | Description
--- | ---
200 StatefulSet | OK
201 StatefulSet | Created

## Misc Operations

See supported operations below...

## Read Scale

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read scale of the specified StatefulSet

### HTTP Request

`GET /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Scale
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 Scale | OK

## Replace Scale

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace scale of the specified StatefulSet

### HTTP Request

`PUT /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Scale
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Scale |

### Response

Code | Description
--- | ---
201 Scale | Created
200 Scale | OK

## Patch Scale

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update scale of the specified StatefulSet

### HTTP Request

`PATCH /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Scale
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 Scale | OK

# DISCOVERY & LOAD BALANCING

Discovery and Load Balancing resources are responsible for stitching your workloads together into an accessible Loadbalanced Service. By default, Workloads are only accessible within the cluster, and they must be exposed externally using a either a LoadBalancer or NodePort Service. For development, internally accessible Workloads can be accessed via proxy through the api master using the `kubectl proxy` command.

Common resource types:

- Services for providing a single ip endpoint loadbalanced across multiple Workload replicas.
- Ingress for providing a https(s) endpoint http(s) routed to one or more Services

# Endpoints v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `Endpoints`

Endpoints is a collection of endpoints that implement the actual service. Example: Name: "mysvc", Subsets: [ { Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] }, { Addresses: [{"ip": "10.10.3.3"}], Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}] }, ]

Appears In:

- EndpointsList core/v1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`subsets` EndpointSubset 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.

### EndpointsList v1 core

Field | Description
--- | ---
`apiVersion` string | 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
`items` Endpoints array | List of endpoints.
`kind` string | 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
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create Endpoints

### HTTP Request

`POST /api/v1/namespaces/{namespace}/endpoints`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Endpoints |

### Response

Code | Description
--- | ---
200 Endpoints | OK
201 Endpoints | Created
202 Endpoints | Accepted

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified Endpoints

### HTTP Request

`PATCH /api/v1/namespaces/{namespace}/endpoints/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Endpoints
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 Endpoints | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified Endpoints

### HTTP Request

`PUT /api/v1/namespaces/{namespace}/endpoints/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Endpoints
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Endpoints |

### Response

Code | Description
--- | ---
200 Endpoints | OK
201 Endpoints | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete Endpoints

### HTTP Request

`DELETE /api/v1/namespaces/{namespace}/endpoints/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Endpoints
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of Endpoints

### HTTP Request

`DELETE /api/v1/namespaces/{namespace}/endpoints`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified Endpoints

### HTTP Request

`GET /api/v1/namespaces/{namespace}/endpoints/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Endpoints
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Response

Code | Description
--- | ---
200 Endpoints | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind Endpoints

### HTTP Request

`GET /api/v1/namespaces/{namespace}/endpoints`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 EndpointsList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind Endpoints

### HTTP Request

`GET /api/v1/endpoints`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 EndpointsList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind Endpoints

### HTTP Request

`GET /api/v1/watch/namespaces/{namespace}/endpoints/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Endpoints
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of Endpoints

### HTTP Request

`GET /api/v1/watch/namespaces/{namespace}/endpoints`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of Endpoints

### HTTP Request

`GET /api/v1/watch/endpoints`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

# Ingress v1beta1 extensions

Group | Version | Kind
--- | --- | ---
`extensions` | `v1beta1` | `Ingress`

Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc.

Appears In:

- IngressList extensions/v1beta1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`spec` IngressSpec | Spec is the desired state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
`status` IngressStatus | Status is the current state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

### IngressSpec v1beta1 extensions

Appears In:

- Ingress extensions/v1beta1

Field | Description
--- | ---
`backend` IngressBackend | 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.
`rules` IngressRule 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.
`tls` IngressTLS 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.

### IngressStatus v1beta1 extensions

Appears In:

- Ingress extensions/v1beta1

Field | Description
--- | ---
`loadBalancer` LoadBalancerStatus | LoadBalancer contains the current status of the load-balancer.

### IngressList v1beta1 extensions

Field | Description
--- | ---
`apiVersion` string | 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
`items` Ingress array | Items is the list of Ingress.
`kind` string | 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
`metadata` ListMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create an Ingress

### HTTP Request

`POST /apis/extensions/v1beta1/namespaces/{namespace}/ingresses`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Ingress |

### Response

Code | Description
--- | ---
200 Ingress | OK
201 Ingress | Created
202 Ingress | Accepted

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified Ingress

### HTTP Request

`PATCH /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Ingress
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 Ingress | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified Ingress

### HTTP Request

`PUT /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Ingress
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Ingress |

### Response

Code | Description
--- | ---
200 Ingress | OK
201 Ingress | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete an Ingress

### HTTP Request

`DELETE /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Ingress
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of Ingress

### HTTP Request

`DELETE /apis/extensions/v1beta1/namespaces/{namespace}/ingresses`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified Ingress

### HTTP Request

`GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Ingress
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Response

Code | Description
--- | ---
200 Ingress | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind Ingress

### HTTP Request

`GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 IngressList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind Ingress

### HTTP Request

`GET /apis/extensions/v1beta1/ingresses`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 IngressList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind Ingress

### HTTP Request

`GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/ingresses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Ingress
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of Ingress

### HTTP Request

`GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/ingresses`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of Ingress

### HTTP Request

`GET /apis/extensions/v1beta1/watch/ingresses`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Status Operations

See supported operations below...

## Patch Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update status of the specified Ingress

### HTTP Request

`PATCH /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Ingress
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 Ingress | OK

## Read Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read status of the specified Ingress

### HTTP Request

`GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Ingress
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 Ingress | OK

## Replace Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace status of the specified Ingress

### HTTP Request

`PUT /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Ingress
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Ingress |

### Response

Code | Description
--- | ---
200 Ingress | OK
201 Ingress | Created

# Service v1 core

> Service Config to load balance traffic across all Pods with the app=nginx label. Receives on and sends to port 80. Exposes an externally accessible endpoint.

    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

> Service Config to load balance traffic across all Pods with the app=nginx label. Receives on and sends to port 80. Exposes an externally accessible endpoint.

    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`

Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy.

Appears In:

- ServiceList core/v1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`spec` ServiceSpec | Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
`status` ServiceStatus | 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

### ServiceSpec v1 core

Appears In:

- Service core/v1

Field | Description
--- | ---
`clusterIP` string | 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
`externalIPs` string 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.
`externalName` string | 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.
`externalTrafficPolicy` string | 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.
`healthCheckNodePort` integer | 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.
`loadBalancerIP` string | 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.
`loadBalancerSourceRanges` string 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/
`ports` ServicePort array patch type: 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
`publishNotReadyAddresses` boolean | 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. This field will replace the service.alpha.kubernetes.io/tolerate-unready-endpoints when that annotation is deprecated and all clients have been converted to use this field.
`selector` object | 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/
`sessionAffinity` string | 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
`sessionAffinityConfig` SessionAffinityConfig | sessionAffinityConfig contains the configurations of session affinity.
`type` string | 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

### ServiceStatus v1 core

Appears In:

- Service core/v1

Field | Description
--- | ---
`loadBalancer` LoadBalancerStatus | LoadBalancer contains the current status of the load-balancer, if one is present.

### ServiceList v1 core

Field | Description
--- | ---
`apiVersion` string | 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
`items` Service array | List of services
`kind` string | 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
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

## Write Operations

See supported operations below...

## Create

> `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

> Output

    service "service-example" created

> Response Body

    {
      "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

### HTTP Request

`POST /api/v1/namespaces/{namespace}/services`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Service |

### Response

Code | Description
--- | ---
200 Service | OK
201 Service | Created
202 Service | Accepted

## Patch

> `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/'

> Output

    "" patched

> Response Body

    {
      "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

### HTTP Request

`PATCH /api/v1/namespaces/{namespace}/services/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Service
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 Service | OK

## Replace

> `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

> Output

    service "deployment-example" replaced

> Response Body

    {
      "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

### HTTP Request

`PUT /api/v1/namespaces/{namespace}/services/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Service
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Service |

### Response

Code | Description
--- | ---
200 Service | OK
201 Service | Created

## Delete

> `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'

> Output

    service "deployment-example" deleted

> Response Body

    {
      "kind": "Status",
      "apiVersion": "v1",
      "metadata": {},
      "status": "Success",
      "code": 200
    }

delete a Service

### HTTP Request

`DELETE /api/v1/namespaces/{namespace}/services/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Service
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `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

> Output

    {
      "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"
            }
          ]
        }
      }
    }

> Response Body

    {
      "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

### HTTP Request

`GET /api/v1/namespaces/{namespace}/services/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Service
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Response

Code | Description
--- | ---
200 Service | OK

## List

> `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'

> Output

> Response Body

list or watch objects of kind Service

### HTTP Request

`GET /api/v1/namespaces/{namespace}/services`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 ServiceList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind Service

### HTTP Request

`GET /api/v1/services`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 ServiceList | OK

## Watch

> `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'

> Output

    {
        "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"
                        }
                    ]
                }
            }
        }
    }

> Response Body

    {
        "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

### HTTP Request

`GET /api/v1/watch/namespaces/{namespace}/services/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Service
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of Service

### HTTP Request

`GET /api/v1/watch/namespaces/{namespace}/services`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of Service

### HTTP Request

`GET /api/v1/watch/services`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Status Operations

See supported operations below...

## Patch Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update status of the specified Service

### HTTP Request

`PATCH /api/v1/namespaces/{namespace}/services/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Service
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 Service | OK

## Read Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read status of the specified Service

### HTTP Request

`GET /api/v1/namespaces/{namespace}/services/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Service
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 Service | OK

## Replace Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace status of the specified Service

### HTTP Request

`PUT /api/v1/namespaces/{namespace}/services/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Service
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Service |

### Response

Code | Description
--- | ---
200 Service | OK
201 Service | Created

## Proxy Operations

See supported operations below...

## Create Connect Proxy

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

connect POST requests to proxy of Service

### HTTP Request

`POST /api/v1/namespaces/{namespace}/services/{name}/proxy`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Service
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

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.

### Response

Code | Description
--- | ---
200 string | OK

## Create Connect Proxy Path

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

connect POST requests to proxy of Service

### HTTP Request

`POST /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Service
`namespace` | object name and auth scope, such as for teams and projects
`path` | path to the resource

### Query Parameters

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.

### Response

Code | Description
--- | ---
200 string | OK

## Delete Connect Proxy

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

connect DELETE requests to proxy of Service

### HTTP Request

`DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Service
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

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.

### Response

Code | Description
--- | ---
200 string | OK

## Delete Connect Proxy Path

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

connect DELETE requests to proxy of Service

### HTTP Request

`DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Service
`namespace` | object name and auth scope, such as for teams and projects
`path` | path to the resource

### Query Parameters

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.

### Response

Code | Description
--- | ---
200 string | OK

## Get Connect Proxy

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

connect GET requests to proxy of Service

### HTTP Request

`GET /api/v1/namespaces/{namespace}/services/{name}/proxy`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Service
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

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.

### Response

Code | Description
--- | ---
200 string | OK

## Get Connect Proxy Path

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

connect GET requests to proxy of Service

### HTTP Request

`GET /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Service
`namespace` | object name and auth scope, such as for teams and projects
`path` | path to the resource

### Query Parameters

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.

### Response

Code | Description
--- | ---
200 string | OK

## Head Connect Proxy

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

connect HEAD requests to proxy of Service

### HTTP Request

`HEAD /api/v1/namespaces/{namespace}/services/{name}/proxy`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Service
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

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.

### Response

Code | Description
--- | ---
200 string | OK

## Head Connect Proxy Path

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

connect HEAD requests to proxy of Service

### HTTP Request

`HEAD /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Service
`namespace` | object name and auth scope, such as for teams and projects
`path` | path to the resource

### Query Parameters

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.

### Response

Code | Description
--- | ---
200 string | OK

## Replace Connect Proxy

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

connect PUT requests to proxy of Service

### HTTP Request

`PUT /api/v1/namespaces/{namespace}/services/{name}/proxy`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Service
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

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.

### Response

Code | Description
--- | ---
200 string | OK

## Replace Connect Proxy Path

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

connect PUT requests to proxy of Service

### HTTP Request

`PUT /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Service
`namespace` | object name and auth scope, such as for teams and projects
`path` | path to the resource

### Query Parameters

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.

### Response

Code | Description
--- | ---
200 string | OK

# CONFIG & STORAGE

Config and Storage resources are responsible for injecting data into your applications and persisting data externally to your container.

Common resource types:

- ConfigMaps for providing text key value pairs injected into the application through environment variables, command line arguments, or files
- Secrets for providing binary data injected into the application through files
- Volumes for providing a filesystem external to the Container. Maybe shared across Containers within the same Pod and have a lifetime persisting beyond a Container or Pod.

# ConfigMap v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `ConfigMap`

ConfigMap holds configuration data for pods to consume.

Appears In:

- ConfigMapList core/v1

Field | Description
--- | ---
`apiVersion` string | 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
`binaryData` object | BinaryData contains the binary data. Each key must consist of alphanumeric characters, '-', '_' or '.'. BinaryData can contain byte sequences that are not in the UTF-8 range. The keys stored in BinaryData must not overlap with the ones in the Data field, this is enforced during validation process. Using this field will require 1.10+ apiserver and kubelet.
`data` object | Data contains the configuration data. Each key must consist of alphanumeric characters, '-', '_' or '.'. Values with non-UTF-8 byte sequences must use the BinaryData field. The keys stored in Data must not overlap with the keys in the BinaryData field, this is enforced during validation process.
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

### ConfigMapList v1 core

Field | Description
--- | ---
`apiVersion` string | 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
`items` ConfigMap array | Items is the list of ConfigMaps.
`kind` string | 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
`metadata` ListMeta | More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a ConfigMap

### HTTP Request

`POST /api/v1/namespaces/{namespace}/configmaps`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ConfigMap |

### Response

Code | Description
--- | ---
200 ConfigMap | OK
201 ConfigMap | Created
202 ConfigMap | Accepted

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified ConfigMap

### HTTP Request

`PATCH /api/v1/namespaces/{namespace}/configmaps/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ConfigMap
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 ConfigMap | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified ConfigMap

### HTTP Request

`PUT /api/v1/namespaces/{namespace}/configmaps/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ConfigMap
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ConfigMap |

### Response

Code | Description
--- | ---
200 ConfigMap | OK
201 ConfigMap | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a ConfigMap

### HTTP Request

`DELETE /api/v1/namespaces/{namespace}/configmaps/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ConfigMap
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of ConfigMap

### HTTP Request

`DELETE /api/v1/namespaces/{namespace}/configmaps`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified ConfigMap

### HTTP Request

`GET /api/v1/namespaces/{namespace}/configmaps/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ConfigMap
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`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.

### Response

Code | Description
--- | ---
200 ConfigMap | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind ConfigMap

### HTTP Request

`GET /api/v1/namespaces/{namespace}/configmaps`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 ConfigMapList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind ConfigMap

### HTTP Request

`GET /api/v1/configmaps`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 ConfigMapList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind ConfigMap

### HTTP Request

`GET /api/v1/watch/namespaces/{namespace}/configmaps/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ConfigMap
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of ConfigMap

### HTTP Request

`GET /api/v1/watch/namespaces/{namespace}/configmaps`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of ConfigMap

### HTTP Request

`GET /api/v1/watch/configmaps`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

# Secret v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `Secret`

Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes.

Appears In:

- SecretList core/v1

Field | Description
--- | ---
`apiVersion` string | 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` object | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`stringData` object | stringData allows specifying non-binary secret data in string form. It is provided as a write-only convenience method. All keys and values are merged into the data field on write, overwriting any existing values. It is never output when reading from the API.
`type` string | Used to facilitate programmatic handling of secret data.

### SecretList v1 core

Field | Description
--- | ---
`apiVersion` string | 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
`items` Secret array | Items is a list of secret objects. More info: https://kubernetes.io/docs/concepts/configuration/secret
`kind` string | 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
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a Secret

### HTTP Request

`POST /api/v1/namespaces/{namespace}/secrets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Secret |

### Response

Code | Description
--- | ---
201 Secret | Created
202 Secret | Accepted
200 Secret | OK

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified Secret

### HTTP Request

`PATCH /api/v1/namespaces/{namespace}/secrets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Secret
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 Secret | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified Secret

### HTTP Request

`PUT /api/v1/namespaces/{namespace}/secrets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Secret
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Secret |

### Response

Code | Description
--- | ---
200 Secret | OK
201 Secret | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a Secret

### HTTP Request

`DELETE /api/v1/namespaces/{namespace}/secrets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Secret
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of Secret

### HTTP Request

`DELETE /api/v1/namespaces/{namespace}/secrets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified Secret

### HTTP Request

`GET /api/v1/namespaces/{namespace}/secrets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Secret
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Response

Code | Description
--- | ---
200 Secret | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind Secret

### HTTP Request

`GET /api/v1/namespaces/{namespace}/secrets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 SecretList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind Secret

### HTTP Request

`GET /api/v1/secrets`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 SecretList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind Secret

### HTTP Request

`GET /api/v1/watch/namespaces/{namespace}/secrets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Secret
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of Secret

### HTTP Request

`GET /api/v1/watch/namespaces/{namespace}/secrets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of Secret

### HTTP Request

`GET /api/v1/watch/secrets`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

# PersistentVolumeClaim v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `PersistentVolumeClaim`

A PersistentVolume must be allocated in the cluster to use this.

PersistentVolumeClaim is a user's request for and claim to a persistent volume

Appears In:

- PersistentVolumeClaimList core/v1
- StatefulSetSpec apps/v1
- StatefulSetSpec apps/v1beta2
- StatefulSetSpec apps/v1beta1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`spec` PersistentVolumeClaimSpec | Spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
`status` PersistentVolumeClaimStatus | Status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

### PersistentVolumeClaimSpec v1 core

Appears In:

- PersistentVolumeClaim core/v1

Field | Description
--- | ---
`accessModes` string array | AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
`resources` ResourceRequirements | Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
`selector` LabelSelector | A label query over volumes to consider for binding.
`storageClassName` string | Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
`volumeMode` string | volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. This is an alpha feature and may change in the future.
`volumeName` string | VolumeName is the binding reference to the PersistentVolume backing this claim.

### PersistentVolumeClaimStatus v1 core

Appears In:

- PersistentVolumeClaim core/v1

Field | Description
--- | ---
`accessModes` string 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
`capacity` object | Represents the actual resources of the underlying volume.
`conditions` PersistentVolumeClaimCondition array patch type: 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'.
`phase` string | Phase represents the current phase of PersistentVolumeClaim.

### PersistentVolumeClaimList v1 core

Field | Description
--- | ---
`apiVersion` string | 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
`items` PersistentVolumeClaim array | A list of persistent volume claims. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
`kind` string | 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
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a PersistentVolumeClaim

### HTTP Request

`POST /api/v1/namespaces/{namespace}/persistentvolumeclaims`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` PersistentVolumeClaim |

### Response

Code | Description
--- | ---
200 PersistentVolumeClaim | OK
201 PersistentVolumeClaim | Created
202 PersistentVolumeClaim | Accepted

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified PersistentVolumeClaim

### HTTP Request

`PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PersistentVolumeClaim
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 PersistentVolumeClaim | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified PersistentVolumeClaim

### HTTP Request

`PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PersistentVolumeClaim
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` PersistentVolumeClaim |

### Response

Code | Description
--- | ---
200 PersistentVolumeClaim | OK
201 PersistentVolumeClaim | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a PersistentVolumeClaim

### HTTP Request

`DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PersistentVolumeClaim
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of PersistentVolumeClaim

### HTTP Request

`DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified PersistentVolumeClaim

### HTTP Request

`GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PersistentVolumeClaim
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Response

Code | Description
--- | ---
200 PersistentVolumeClaim | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind PersistentVolumeClaim

### HTTP Request

`GET /api/v1/namespaces/{namespace}/persistentvolumeclaims`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 PersistentVolumeClaimList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind PersistentVolumeClaim

### HTTP Request

`GET /api/v1/persistentvolumeclaims`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 PersistentVolumeClaimList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind PersistentVolumeClaim

### HTTP Request

`GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PersistentVolumeClaim
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of PersistentVolumeClaim

### HTTP Request

`GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of PersistentVolumeClaim

### HTTP Request

`GET /api/v1/watch/persistentvolumeclaims`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Status Operations

See supported operations below...

## Patch Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update status of the specified PersistentVolumeClaim

### HTTP Request

`PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PersistentVolumeClaim
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 PersistentVolumeClaim | OK

## Read Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read status of the specified PersistentVolumeClaim

### HTTP Request

`GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PersistentVolumeClaim
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 PersistentVolumeClaim | OK

## Replace Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace status of the specified PersistentVolumeClaim

### HTTP Request

`PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PersistentVolumeClaim
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` PersistentVolumeClaim |

### Response

Code | Description
--- | ---
200 PersistentVolumeClaim | OK
201 PersistentVolumeClaim | Created

# StorageClass v1 storage.k8s.io

Group | Version | Kind
--- | --- | ---
`storage.k8s.io` | `v1` | `StorageClass`

Other api versions of this object exist: v1beta1

StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned.

StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name.

Appears In:

- StorageClassList storage/v1

Field | Description
--- | ---
`allowVolumeExpansion` boolean | AllowVolumeExpansion shows whether the storage class allow volume expand
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`mountOptions` string array | Dynamically provisioned PersistentVolumes of this storage class are created with these mountOptions, e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid.
`parameters` object | Parameters holds the parameters for the provisioner that should create volumes of this storage class.
`provisioner` string | Provisioner indicates the type of the provisioner.
`reclaimPolicy` string | Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. Defaults to Delete.
`volumeBindingMode` string | VolumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is alpha-level and is only honored by servers that enable the VolumeScheduling feature.

### StorageClassList v1 storage

Field | Description
--- | ---
`apiVersion` string | 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
`items` StorageClass array | Items is the list of StorageClasses
`kind` string | 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
`metadata` ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a StorageClass

### HTTP Request

`POST /apis/storage.k8s.io/v1/storageclasses`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` StorageClass |

### Response

Code | Description
--- | ---
202 StorageClass | Accepted
200 StorageClass | OK
201 StorageClass | Created

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified StorageClass

### HTTP Request

`PATCH /apis/storage.k8s.io/v1/storageclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StorageClass

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 StorageClass | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified StorageClass

### HTTP Request

`PUT /apis/storage.k8s.io/v1/storageclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StorageClass

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` StorageClass |

### Response

Code | Description
--- | ---
200 StorageClass | OK
201 StorageClass | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a StorageClass

### HTTP Request

`DELETE /apis/storage.k8s.io/v1/storageclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StorageClass

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of StorageClass

### HTTP Request

`DELETE /apis/storage.k8s.io/v1/storageclasses`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified StorageClass

### HTTP Request

`GET /apis/storage.k8s.io/v1/storageclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StorageClass

### Query Parameters

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.

### Response

Code | Description
--- | ---
200 StorageClass | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind StorageClass

### HTTP Request

`GET /apis/storage.k8s.io/v1/storageclasses`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 StorageClassList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind StorageClass

### HTTP Request

`GET /apis/storage.k8s.io/v1/watch/storageclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StorageClass

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of StorageClass

### HTTP Request

`GET /apis/storage.k8s.io/v1/watch/storageclasses`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

# Volume v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `Volume`

Volume represents a named volume in a pod that may be accessed by any container in the pod.

Appears In:

- PodPresetSpec settings/v1alpha1
- PodSpec core/v1

Field | Description
--- | ---
`awsElasticBlockStore` AWSElasticBlockStoreVolumeSource | 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
`azureDisk` AzureDiskVolumeSource | AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
`azureFile` AzureFileVolumeSource | AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
`cephfs` CephFSVolumeSource | CephFS represents a Ceph FS mount on the host that shares a pod's lifetime
`cinder` CinderVolumeSource | 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
`configMap` ConfigMapVolumeSource | ConfigMap represents a configMap that should populate this volume
`downwardAPI` DownwardAPIVolumeSource | DownwardAPI represents downward API about the pod that should populate this volume
`emptyDir` EmptyDirVolumeSource | EmptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
`fc` FCVolumeSource | FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
`flexVolume` FlexVolumeSource | FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
`flocker` FlockerVolumeSource | Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
`gcePersistentDisk` GCEPersistentDiskVolumeSource | 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
`gitRepo` GitRepoVolumeSource | GitRepo represents a git repository at a particular revision.
`glusterfs` GlusterfsVolumeSource | 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
`hostPath` HostPathVolumeSource | 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
`iscsi` ISCSIVolumeSource | 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
`name` string | 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
`nfs` NFSVolumeSource | NFS represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
`persistentVolumeClaim` PersistentVolumeClaimVolumeSource | PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
`photonPersistentDisk` PhotonPersistentDiskVolumeSource | PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
`portworxVolume` PortworxVolumeSource | PortworxVolume represents a portworx volume attached and mounted on kubelets host machine
`projected` ProjectedVolumeSource | Items for all in one resources secrets, configmaps, and downward API
`quobyte` QuobyteVolumeSource | Quobyte represents a Quobyte mount on the host that shares a pod's lifetime
`rbd` RBDVolumeSource | 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
`scaleIO` ScaleIOVolumeSource | ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
`secret` SecretVolumeSource | Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
`storageos` StorageOSVolumeSource | StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
`vsphereVolume` VsphereVirtualDiskVolumeSource | VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

# VolumeAttachment v1beta1 storage.k8s.io

Group | Version | Kind
--- | --- | ---
`storage.k8s.io` | `v1beta1` | `VolumeAttachment`

Other api versions of this object exist: v1alpha1

VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node.

VolumeAttachment objects are non-namespaced.

Appears In:

- VolumeAttachmentList storage/v1beta1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`spec` VolumeAttachmentSpec | Specification of the desired attach/detach volume behavior. Populated by the Kubernetes system.
`status` VolumeAttachmentStatus | Status of the VolumeAttachment request. Populated by the entity completing the attach or detach operation, i.e. the external-attacher.

### VolumeAttachmentSpec v1beta1 storage

Appears In:

- VolumeAttachment storage/v1beta1

Field | Description
--- | ---
`attacher` string | Attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName().
`nodeName` string | The node that the volume should be attached to.
`source` VolumeAttachmentSource | Source represents the volume that should be attached.

### VolumeAttachmentStatus v1beta1 storage

Appears In:

- VolumeAttachment storage/v1beta1

Field | Description
--- | ---
`attachError` VolumeError | The last error encountered during attach operation, if any. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
`attached` boolean | Indicates the volume is successfully attached. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
`attachmentMetadata` object | Upon successful attach, this field is populated with any information returned by the attach operation that must be passed into subsequent WaitForAttach or Mount calls. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
`detachError` VolumeError | 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.

### VolumeAttachmentList v1beta1 storage

Field | Description
--- | ---
`apiVersion` string | 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
`items` VolumeAttachment array | Items is the list of VolumeAttachments
`kind` string | 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
`metadata` ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a VolumeAttachment

### HTTP Request

`POST /apis/storage.k8s.io/v1beta1/volumeattachments`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` VolumeAttachment |

### Response

Code | Description
--- | ---
200 VolumeAttachment | OK
201 VolumeAttachment | Created
202 VolumeAttachment | Accepted

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified VolumeAttachment

### HTTP Request

`PATCH /apis/storage.k8s.io/v1beta1/volumeattachments/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the VolumeAttachment

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 VolumeAttachment | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified VolumeAttachment

### HTTP Request

`PUT /apis/storage.k8s.io/v1beta1/volumeattachments/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the VolumeAttachment

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` VolumeAttachment |

### Response

Code | Description
--- | ---
200 VolumeAttachment | OK
201 VolumeAttachment | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a VolumeAttachment

### HTTP Request

`DELETE /apis/storage.k8s.io/v1beta1/volumeattachments/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the VolumeAttachment

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of VolumeAttachment

### HTTP Request

`DELETE /apis/storage.k8s.io/v1beta1/volumeattachments`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified VolumeAttachment

### HTTP Request

`GET /apis/storage.k8s.io/v1beta1/volumeattachments/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the VolumeAttachment

### Query Parameters

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.

### Response

Code | Description
--- | ---
200 VolumeAttachment | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind VolumeAttachment

### HTTP Request

`GET /apis/storage.k8s.io/v1beta1/volumeattachments`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 VolumeAttachmentList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind VolumeAttachment

### HTTP Request

`GET /apis/storage.k8s.io/v1beta1/watch/volumeattachments/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the VolumeAttachment

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of VolumeAttachment

### HTTP Request

`GET /apis/storage.k8s.io/v1beta1/watch/volumeattachments`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

# METADATA

Metadata resources are responsible for configuring behavior of your other Resources within the Cluster.

Common resource types:

- HorizontalPodAutoscaler (HPA) for automatically scaling the replicacount of your workloads in response to load
- PodDisruptionBudget for configuring how many replicas in a given workload maybe made concurrently unavailable when performing maintenance.
- ThirdPartyResource for extending the Kubernetes APIs with your own types
- Event for notification of resource lifecycle events in the cluster.

# ControllerRevision v1 apps

Group | Version | Kind
--- | --- | ---
`apps` | `v1` | `ControllerRevision`

Other api versions of this object exist: v1beta2 v1beta1

ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers.

Appears In:

- ControllerRevisionList apps/v1

Field | Description
--- | ---
`apiVersion` string | 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.
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`revision` integer | Revision indicates the revision of the state represented by Data.

### ControllerRevisionList v1 apps

Field | Description
--- | ---
`apiVersion` string | 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
`items` ControllerRevision array | Items is the list of ControllerRevisions
`kind` string | 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
`metadata` ListMeta | More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a ControllerRevision

### HTTP Request

`POST /apis/apps/v1/namespaces/{namespace}/controllerrevisions`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ControllerRevision |

### Response

Code | Description
--- | ---
201 ControllerRevision | Created
202 ControllerRevision | Accepted
200 ControllerRevision | OK

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified ControllerRevision

### HTTP Request

`PATCH /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ControllerRevision
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 ControllerRevision | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified ControllerRevision

### HTTP Request

`PUT /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ControllerRevision
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ControllerRevision |

### Response

Code | Description
--- | ---
200 ControllerRevision | OK
201 ControllerRevision | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a ControllerRevision

### HTTP Request

`DELETE /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ControllerRevision
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of ControllerRevision

### HTTP Request

`DELETE /apis/apps/v1/namespaces/{namespace}/controllerrevisions`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified ControllerRevision

### HTTP Request

`GET /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ControllerRevision
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

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.

### Response

Code | Description
--- | ---
200 ControllerRevision | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind ControllerRevision

### HTTP Request

`GET /apis/apps/v1/namespaces/{namespace}/controllerrevisions`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 ControllerRevisionList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind ControllerRevision

### HTTP Request

`GET /apis/apps/v1/controllerrevisions`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 ControllerRevisionList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind ControllerRevision

### HTTP Request

`GET /apis/apps/v1/watch/namespaces/{namespace}/controllerrevisions/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ControllerRevision
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of ControllerRevision

### HTTP Request

`GET /apis/apps/v1/watch/namespaces/{namespace}/controllerrevisions`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of ControllerRevision

### HTTP Request

`GET /apis/apps/v1/watch/controllerrevisions`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

# CustomResourceDefinition v1beta1 apiextensions.k8s.io

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1beta1` | `CustomResourceDefinition`

CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>.

Appears In:

- CustomResourceDefinitionList apiextensions/v1beta1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta |
`spec` CustomResourceDefinitionSpec | Spec describes how the user wants the resources to appear
`status` CustomResourceDefinitionStatus | Status indicates the actual state of the CustomResourceDefinition

### CustomResourceDefinitionSpec v1beta1 apiextensions

Appears In:

- CustomResourceDefinition apiextensions/v1beta1

Field | Description
--- | ---
`group` string | Group is the group this resource belongs in
`names` CustomResourceDefinitionNames | Names are the names used to describe this custom resource
`scope` string | Scope indicates whether this resource is cluster or namespace scoped. Default is namespaced
`subresources` CustomResourceSubresources | Subresources describes the subresources for CustomResources This field is alpha-level and should only be sent to servers that enable subresources via the CustomResourceSubresources feature gate.
`validation` CustomResourceValidation | Validation describes the validation methods for CustomResources
`version` string | Version is the version this resource belongs in

### CustomResourceDefinitionStatus v1beta1 apiextensions

Appears In:

- CustomResourceDefinition apiextensions/v1beta1

Field | Description
--- | ---
`acceptedNames` CustomResourceDefinitionNames | AcceptedNames are the names that are actually being used to serve discovery They may be different than the names in spec.
`conditions` CustomResourceDefinitionCondition array | Conditions indicate state for particular aspects of a CustomResourceDefinition

### CustomResourceDefinitionList v1beta1 apiextensions

Field | Description
--- | ---
`apiVersion` string | 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
`items` CustomResourceDefinition array | Items individual CustomResourceDefinitions
`kind` string | 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
`metadata` ListMeta |

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a CustomResourceDefinition

### HTTP Request

`POST /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` CustomResourceDefinition |

### Response

Code | Description
--- | ---
201 CustomResourceDefinition | Created
202 CustomResourceDefinition | Accepted
200 CustomResourceDefinition | OK

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified CustomResourceDefinition

### HTTP Request

`PATCH /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CustomResourceDefinition

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 CustomResourceDefinition | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified CustomResourceDefinition

### HTTP Request

`PUT /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CustomResourceDefinition

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` CustomResourceDefinition |

### Response

Code | Description
--- | ---
200 CustomResourceDefinition | OK
201 CustomResourceDefinition | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a CustomResourceDefinition

### HTTP Request

`DELETE /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CustomResourceDefinition

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of CustomResourceDefinition

### HTTP Request

`DELETE /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified CustomResourceDefinition

### HTTP Request

`GET /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CustomResourceDefinition

### Query Parameters

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.

### Response

Code | Description
--- | ---
200 CustomResourceDefinition | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind CustomResourceDefinition

### HTTP Request

`GET /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 CustomResourceDefinitionList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind CustomResourceDefinition

### HTTP Request

`GET /apis/apiextensions.k8s.io/v1beta1/watch/customresourcedefinitions/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CustomResourceDefinition

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of CustomResourceDefinition

### HTTP Request

`GET /apis/apiextensions.k8s.io/v1beta1/watch/customresourcedefinitions`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Status Operations

See supported operations below...

## Replace Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace status of the specified CustomResourceDefinition

### HTTP Request

`PUT /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CustomResourceDefinition

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` CustomResourceDefinition |

### Response

Code | Description
--- | ---
201 CustomResourceDefinition | Created
200 CustomResourceDefinition | OK

# Event v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `Event`

Other api versions of this object exist: v1beta1

Event is a report of an event somewhere in the cluster.

Appears In:

- EventList core/v1

Field | Description
--- | ---
`action` string | What action was taken/failed regarding to the Regarding object.
`apiVersion` string | 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
`count` integer | The number of times this event has occurred.
`eventTime` MicroTime | Time when this Event was first observed.
`firstTimestamp` Time | The time at which the event was first recorded. (Time of server receipt is in TypeMeta.)
`involvedObject` ObjectReference | The object that this event is about.
`kind` string | 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
`lastTimestamp` Time | The time at which the most recent occurrence of this event was recorded.
`message` string | A human-readable description of the status of this operation.
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`reason` string | This should be a short, machine understandable string that gives the reason for the transition into the object's current status.
`related` ObjectReference | Optional secondary object for more complex actions.
`reportingComponent` string | Name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`.
`reportingInstance` string | ID of the controller instance, e.g. `kubelet-xyzf`.
`series` EventSeries | Data about the Event series this event represents or nil if it's a singleton Event.
`source` EventSource | The component reporting this event. Should be a short machine understandable string.
`type` string | Type of this event (Normal, Warning), new types could be added in the future

### EventList v1 core

Field | Description
--- | ---
`apiVersion` string | 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
`items` Event array | List of events
`kind` string | 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
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create an Event

### HTTP Request

`POST /api/v1/namespaces/{namespace}/events`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Event |

### Response

Code | Description
--- | ---
201 Event | Created
202 Event | Accepted
200 Event | OK

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified Event

### HTTP Request

`PATCH /api/v1/namespaces/{namespace}/events/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Event
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 Event | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified Event

### HTTP Request

`PUT /api/v1/namespaces/{namespace}/events/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Event
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Event |

### Response

Code | Description
--- | ---
200 Event | OK
201 Event | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete an Event

### HTTP Request

`DELETE /api/v1/namespaces/{namespace}/events/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Event
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of Event

### HTTP Request

`DELETE /api/v1/namespaces/{namespace}/events`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified Event

### HTTP Request

`GET /api/v1/namespaces/{namespace}/events/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Event
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

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.

### Response

Code | Description
--- | ---
200 Event | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind Event

### HTTP Request

`GET /api/v1/namespaces/{namespace}/events`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 EventList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind Event

### HTTP Request

`GET /api/v1/events`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 EventList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind Event

### HTTP Request

`GET /api/v1/watch/namespaces/{namespace}/events/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Event
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of Event

### HTTP Request

`GET /api/v1/watch/namespaces/{namespace}/events`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of Event

### HTTP Request

`GET /api/v1/watch/events`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

# LimitRange v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `LimitRange`

LimitRange sets resource usage limits for each kind of resource in a Namespace.

Appears In:

- LimitRangeList core/v1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`spec` LimitRangeSpec | Spec defines the limits enforced. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

### LimitRangeSpec v1 core

Appears In:

- LimitRange core/v1

Field | Description
--- | ---
`limits` LimitRangeItem array | Limits is the list of LimitRangeItem objects that are enforced.

### LimitRangeList v1 core

Field | Description
--- | ---
`apiVersion` string | 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
`items` LimitRange array | Items is a list of LimitRange objects. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
`kind` string | 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
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a LimitRange

### HTTP Request

`POST /api/v1/namespaces/{namespace}/limitranges`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` LimitRange |

### Response

Code | Description
--- | ---
202 LimitRange | Accepted
200 LimitRange | OK
201 LimitRange | Created

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified LimitRange

### HTTP Request

`PATCH /api/v1/namespaces/{namespace}/limitranges/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the LimitRange
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 LimitRange | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified LimitRange

### HTTP Request

`PUT /api/v1/namespaces/{namespace}/limitranges/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the LimitRange
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` LimitRange |

### Response

Code | Description
--- | ---
200 LimitRange | OK
201 LimitRange | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a LimitRange

### HTTP Request

`DELETE /api/v1/namespaces/{namespace}/limitranges/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the LimitRange
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of LimitRange

### HTTP Request

`DELETE /api/v1/namespaces/{namespace}/limitranges`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified LimitRange

### HTTP Request

`GET /api/v1/namespaces/{namespace}/limitranges/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the LimitRange
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Response

Code | Description
--- | ---
200 LimitRange | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind LimitRange

### HTTP Request

`GET /api/v1/namespaces/{namespace}/limitranges`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 LimitRangeList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind LimitRange

### HTTP Request

`GET /api/v1/limitranges`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 LimitRangeList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind LimitRange

### HTTP Request

`GET /api/v1/watch/namespaces/{namespace}/limitranges/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the LimitRange
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of LimitRange

### HTTP Request

`GET /api/v1/watch/namespaces/{namespace}/limitranges`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of LimitRange

### HTTP Request

`GET /api/v1/watch/limitranges`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

# HorizontalPodAutoscaler v1 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v1` | `HorizontalPodAutoscaler`

Other api versions of this object exist: v2beta1

configuration of a horizontal pod autoscaler.

Appears In:

- HorizontalPodAutoscalerList autoscaling/v1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`spec` HorizontalPodAutoscalerSpec | behaviour of autoscaler. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status.
`status` HorizontalPodAutoscalerStatus | current information about the autoscaler.

### HorizontalPodAutoscalerSpec v1 autoscaling

Appears In:

- HorizontalPodAutoscaler autoscaling/v1

Field | Description
--- | ---
`maxReplicas` integer | upper limit for the number of pods that can be set by the autoscaler; cannot be smaller than MinReplicas.
`minReplicas` integer | lower limit for the number of pods that can be set by the autoscaler, default 1.
`scaleTargetRef` CrossVersionObjectReference | reference to scaled resource; horizontal pod autoscaler will learn the current resource consumption and will set the desired number of pods by using its Scale subresource.
`targetCPUUtilizationPercentage` integer | target average CPU utilization (represented as a percentage of requested CPU) over all the pods; if not specified the default autoscaling policy will be used.

### HorizontalPodAutoscalerStatus v1 autoscaling

Appears In:

- HorizontalPodAutoscaler autoscaling/v1

Field | Description
--- | ---
`currentCPUUtilizationPercentage` integer | current average CPU utilization over all pods, represented as a percentage of requested CPU, e.g. 70 means that an average pod is using now 70% of its requested CPU.
`currentReplicas` integer | current number of replicas of pods managed by this autoscaler.
`desiredReplicas` integer | desired number of replicas of pods managed by this autoscaler.
`lastScaleTime` Time | last time the HorizontalPodAutoscaler scaled the number of pods; used by the autoscaler to control how often the number of pods is changed.
`observedGeneration` integer | most recent generation observed by this autoscaler.

### HorizontalPodAutoscalerList v1 autoscaling

Field | Description
--- | ---
`apiVersion` string | 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
`items` HorizontalPodAutoscaler array | list of horizontal pod autoscaler objects.
`kind` string | 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
`metadata` ListMeta | Standard list metadata.

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a HorizontalPodAutoscaler

### HTTP Request

`POST /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` HorizontalPodAutoscaler |

### Response

Code | Description
--- | ---
201 HorizontalPodAutoscaler | Created
202 HorizontalPodAutoscaler | Accepted
200 HorizontalPodAutoscaler | OK

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified HorizontalPodAutoscaler

### HTTP Request

`PATCH /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the HorizontalPodAutoscaler
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 HorizontalPodAutoscaler | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified HorizontalPodAutoscaler

### HTTP Request

`PUT /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the HorizontalPodAutoscaler
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` HorizontalPodAutoscaler |

### Response

Code | Description
--- | ---
200 HorizontalPodAutoscaler | OK
201 HorizontalPodAutoscaler | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a HorizontalPodAutoscaler

### HTTP Request

`DELETE /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the HorizontalPodAutoscaler
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of HorizontalPodAutoscaler

### HTTP Request

`DELETE /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified HorizontalPodAutoscaler

### HTTP Request

`GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the HorizontalPodAutoscaler
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Response

Code | Description
--- | ---
200 HorizontalPodAutoscaler | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind HorizontalPodAutoscaler

### HTTP Request

`GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 HorizontalPodAutoscalerList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind HorizontalPodAutoscaler

### HTTP Request

`GET /apis/autoscaling/v1/horizontalpodautoscalers`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 HorizontalPodAutoscalerList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind HorizontalPodAutoscaler

### HTTP Request

`GET /apis/autoscaling/v1/watch/namespaces/{namespace}/horizontalpodautoscalers/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the HorizontalPodAutoscaler
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of HorizontalPodAutoscaler

### HTTP Request

`GET /apis/autoscaling/v1/watch/namespaces/{namespace}/horizontalpodautoscalers`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of HorizontalPodAutoscaler

### HTTP Request

`GET /apis/autoscaling/v1/watch/horizontalpodautoscalers`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Status Operations

See supported operations below...

## Patch Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update status of the specified HorizontalPodAutoscaler

### HTTP Request

`PATCH /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the HorizontalPodAutoscaler
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 HorizontalPodAutoscaler | OK

## Read Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read status of the specified HorizontalPodAutoscaler

### HTTP Request

`GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the HorizontalPodAutoscaler
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 HorizontalPodAutoscaler | OK

## Replace Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace status of the specified HorizontalPodAutoscaler

### HTTP Request

`PUT /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the HorizontalPodAutoscaler
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` HorizontalPodAutoscaler |

### Response

Code | Description
--- | ---
201 HorizontalPodAutoscaler | Created
200 HorizontalPodAutoscaler | OK

# InitializerConfiguration v1alpha1 admissionregistration.k8s.io

Group | Version | Kind
--- | --- | ---
`admissionregistration.k8s.io` | `v1alpha1` | `InitializerConfiguration`

InitializerConfiguration describes the configuration of initializers.

Appears In:

- InitializerConfigurationList admissionregistration/v1alpha1

Field | Description
--- | ---
`apiVersion` string | 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
`initializers` Initializer array patch type: merge patch merge key: name | Initializers is a list of resources and their default initializers Order-sensitive. When merging multiple InitializerConfigurations, we sort the initializers from different InitializerConfigurations by the name of the InitializerConfigurations; the order of the initializers from the same InitializerConfiguration is preserved.
`kind` string | 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
`metadata` ObjectMeta | Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata.

### InitializerConfigurationList v1alpha1 admissionregistration

Field | Description
--- | ---
`apiVersion` string | 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
`items` InitializerConfiguration array | List of InitializerConfiguration.
`kind` string | 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
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create an InitializerConfiguration

### HTTP Request

`POST /apis/admissionregistration.k8s.io/v1alpha1/initializerconfigurations`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` InitializerConfiguration |

### Response

Code | Description
--- | ---
200 InitializerConfiguration | OK
201 InitializerConfiguration | Created
202 InitializerConfiguration | Accepted

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified InitializerConfiguration

### HTTP Request

`PATCH /apis/admissionregistration.k8s.io/v1alpha1/initializerconfigurations/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the InitializerConfiguration

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 InitializerConfiguration | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified InitializerConfiguration

### HTTP Request

`PUT /apis/admissionregistration.k8s.io/v1alpha1/initializerconfigurations/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the InitializerConfiguration

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` InitializerConfiguration |

### Response

Code | Description
--- | ---
200 InitializerConfiguration | OK
201 InitializerConfiguration | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete an InitializerConfiguration

### HTTP Request

`DELETE /apis/admissionregistration.k8s.io/v1alpha1/initializerconfigurations/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the InitializerConfiguration

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of InitializerConfiguration

### HTTP Request

`DELETE /apis/admissionregistration.k8s.io/v1alpha1/initializerconfigurations`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified InitializerConfiguration

### HTTP Request

`GET /apis/admissionregistration.k8s.io/v1alpha1/initializerconfigurations/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the InitializerConfiguration

### Query Parameters

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.

### Response

Code | Description
--- | ---
200 InitializerConfiguration | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind InitializerConfiguration

### HTTP Request

`GET /apis/admissionregistration.k8s.io/v1alpha1/initializerconfigurations`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 InitializerConfigurationList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind InitializerConfiguration

### HTTP Request

`GET /apis/admissionregistration.k8s.io/v1alpha1/watch/initializerconfigurations/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the InitializerConfiguration

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of InitializerConfiguration

### HTTP Request

`GET /apis/admissionregistration.k8s.io/v1alpha1/watch/initializerconfigurations`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

# MutatingWebhookConfiguration v1beta1 admissionregistration.k8s.io

Group | Version | Kind
--- | --- | ---
`admissionregistration.k8s.io` | `v1beta1` | `MutatingWebhookConfiguration`

MutatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and may change the object.

Appears In:

- MutatingWebhookConfigurationList admissionregistration/v1beta1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata.
`webhooks` Webhook array patch type: merge patch merge key: name | Webhooks is a list of webhooks and the affected resources and operations.

### MutatingWebhookConfigurationList v1beta1 admissionregistration

Field | Description
--- | ---
`apiVersion` string | 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
`items` MutatingWebhookConfiguration array | List of MutatingWebhookConfiguration.
`kind` string | 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
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a MutatingWebhookConfiguration

### HTTP Request

`POST /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` MutatingWebhookConfiguration |

### Response

Code | Description
--- | ---
200 MutatingWebhookConfiguration | OK
201 MutatingWebhookConfiguration | Created
202 MutatingWebhookConfiguration | Accepted

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified MutatingWebhookConfiguration

### HTTP Request

`PATCH /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the MutatingWebhookConfiguration

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 MutatingWebhookConfiguration | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified MutatingWebhookConfiguration

### HTTP Request

`PUT /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the MutatingWebhookConfiguration

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` MutatingWebhookConfiguration |

### Response

Code | Description
--- | ---
200 MutatingWebhookConfiguration | OK
201 MutatingWebhookConfiguration | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a MutatingWebhookConfiguration

### HTTP Request

`DELETE /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the MutatingWebhookConfiguration

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of MutatingWebhookConfiguration

### HTTP Request

`DELETE /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified MutatingWebhookConfiguration

### HTTP Request

`GET /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the MutatingWebhookConfiguration

### Query Parameters

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.

### Response

Code | Description
--- | ---
200 MutatingWebhookConfiguration | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind MutatingWebhookConfiguration

### HTTP Request

`GET /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 MutatingWebhookConfigurationList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind MutatingWebhookConfiguration

### HTTP Request

`GET /apis/admissionregistration.k8s.io/v1beta1/watch/mutatingwebhookconfigurations/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the MutatingWebhookConfiguration

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of MutatingWebhookConfiguration

### HTTP Request

`GET /apis/admissionregistration.k8s.io/v1beta1/watch/mutatingwebhookconfigurations`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

# ValidatingWebhookConfiguration v1beta1 admissionregistration.k8s.io

Group | Version | Kind
--- | --- | ---
`admissionregistration.k8s.io` | `v1beta1` | `ValidatingWebhookConfiguration`

ValidatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and object without changing it.

Appears In:

- ValidatingWebhookConfigurationList admissionregistration/v1beta1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata.
`webhooks` Webhook array patch type: merge patch merge key: name | Webhooks is a list of webhooks and the affected resources and operations.

### ValidatingWebhookConfigurationList v1beta1 admissionregistration

Field | Description
--- | ---
`apiVersion` string | 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
`items` ValidatingWebhookConfiguration array | List of ValidatingWebhookConfiguration.
`kind` string | 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
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a ValidatingWebhookConfiguration

### HTTP Request

`POST /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ValidatingWebhookConfiguration |

### Response

Code | Description
--- | ---
200 ValidatingWebhookConfiguration | OK
201 ValidatingWebhookConfiguration | Created
202 ValidatingWebhookConfiguration | Accepted

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified ValidatingWebhookConfiguration

### HTTP Request

`PATCH /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ValidatingWebhookConfiguration

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 ValidatingWebhookConfiguration | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified ValidatingWebhookConfiguration

### HTTP Request

`PUT /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ValidatingWebhookConfiguration

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ValidatingWebhookConfiguration |

### Response

Code | Description
--- | ---
201 ValidatingWebhookConfiguration | Created
200 ValidatingWebhookConfiguration | OK

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a ValidatingWebhookConfiguration

### HTTP Request

`DELETE /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ValidatingWebhookConfiguration

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of ValidatingWebhookConfiguration

### HTTP Request

`DELETE /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified ValidatingWebhookConfiguration

### HTTP Request

`GET /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ValidatingWebhookConfiguration

### Query Parameters

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.

### Response

Code | Description
--- | ---
200 ValidatingWebhookConfiguration | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind ValidatingWebhookConfiguration

### HTTP Request

`GET /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 ValidatingWebhookConfigurationList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind ValidatingWebhookConfiguration

### HTTP Request

`GET /apis/admissionregistration.k8s.io/v1beta1/watch/validatingwebhookconfigurations/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ValidatingWebhookConfiguration

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of ValidatingWebhookConfiguration

### HTTP Request

`GET /apis/admissionregistration.k8s.io/v1beta1/watch/validatingwebhookconfigurations`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

# PodTemplate v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `PodTemplate`

PodTemplate describes a template for creating copies of a predefined pod.

Appears In:

- PodTemplateList core/v1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`template` PodTemplateSpec | 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

### PodTemplateSpec v1 core

Appears In:

- DaemonSetSpec apps/v1
- DaemonSetSpec apps/v1beta2
- DaemonSetSpec extensions/v1beta1
- DeploymentSpec apps/v1
- DeploymentSpec apps/v1beta2
- DeploymentSpec apps/v1beta1
- DeploymentSpec extensions/v1beta1
- JobSpec batch/v1
- PodTemplate core/v1
- ReplicaSetSpec apps/v1
- ReplicaSetSpec apps/v1beta2
- ReplicaSetSpec extensions/v1beta1
- ReplicationControllerSpec core/v1
- StatefulSetSpec apps/v1
- StatefulSetSpec apps/v1beta2
- StatefulSetSpec apps/v1beta1

Field | Description
--- | ---
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`spec` PodSpec | Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

### PodTemplateList v1 core

Field | Description
--- | ---
`apiVersion` string | 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
`items` PodTemplate array | List of pod templates
`kind` string | 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
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a PodTemplate

### HTTP Request

`POST /api/v1/namespaces/{namespace}/podtemplates`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` PodTemplate |

### Response

Code | Description
--- | ---
201 PodTemplate | Created
202 PodTemplate | Accepted
200 PodTemplate | OK

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified PodTemplate

### HTTP Request

`PATCH /api/v1/namespaces/{namespace}/podtemplates/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PodTemplate
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 PodTemplate | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified PodTemplate

### HTTP Request

`PUT /api/v1/namespaces/{namespace}/podtemplates/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PodTemplate
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` PodTemplate |

### Response

Code | Description
--- | ---
200 PodTemplate | OK
201 PodTemplate | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a PodTemplate

### HTTP Request

`DELETE /api/v1/namespaces/{namespace}/podtemplates/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PodTemplate
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of PodTemplate

### HTTP Request

`DELETE /api/v1/namespaces/{namespace}/podtemplates`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified PodTemplate

### HTTP Request

`GET /api/v1/namespaces/{namespace}/podtemplates/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PodTemplate
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Response

Code | Description
--- | ---
200 PodTemplate | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind PodTemplate

### HTTP Request

`GET /api/v1/namespaces/{namespace}/podtemplates`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 PodTemplateList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind PodTemplate

### HTTP Request

`GET /api/v1/podtemplates`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 PodTemplateList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind PodTemplate

### HTTP Request

`GET /api/v1/watch/namespaces/{namespace}/podtemplates/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PodTemplate
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of PodTemplate

### HTTP Request

`GET /api/v1/watch/namespaces/{namespace}/podtemplates`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of PodTemplate

### HTTP Request

`GET /api/v1/watch/podtemplates`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

# PodDisruptionBudget v1beta1 policy

Group | Version | Kind
--- | --- | ---
`policy` | `v1beta1` | `PodDisruptionBudget`

PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods

Appears In:

- PodDisruptionBudgetList policy/v1beta1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta |
`spec` PodDisruptionBudgetSpec | Specification of the desired behavior of the PodDisruptionBudget.
`status` PodDisruptionBudgetStatus | Most recently observed status of the PodDisruptionBudget.

### PodDisruptionBudgetSpec v1beta1 policy

Appears In:

- PodDisruptionBudget policy/v1beta1

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%".
`selector` LabelSelector | Label query over pods whose evictions are managed by the disruption budget.

### PodDisruptionBudgetStatus v1beta1 policy

Appears In:

- PodDisruptionBudget policy/v1beta1

Field | Description
--- | ---
`currentHealthy` integer | current number of healthy pods
`desiredHealthy` integer | minimum desired number of healthy pods
`disruptedPods` object | DisruptedPods contains information about pods whose eviction was processed by the API server eviction subresource handler but has not yet been observed by the PodDisruptionBudget controller. A pod will be in this map from the time when the API server processed the eviction request to the time when the pod is seen by PDB controller as having been marked for deletion (or after a timeout). The key in the map is the name of the pod and the value is the time when the API server processed the eviction request. If the deletion didn't occur and a pod is still there it will be removed from the list automatically by PodDisruptionBudget controller after some time. If everything goes smooth this map should be empty for the most of the time. Large number of entries in the map may indicate problems with pod deletions.
`disruptionsAllowed` integer | Number of pod disruptions that are currently allowed.
`expectedPods` integer | total number of pods counted by this disruption budget
`observedGeneration` integer | Most recent generation observed when updating this PDB status. PodDisruptionsAllowed and other status informatio is valid only if observedGeneration equals to PDB's object generation.

### PodDisruptionBudgetList v1beta1 policy

Field | Description
--- | ---
`apiVersion` string | 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
`items` PodDisruptionBudget array |
`kind` string | 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
`metadata` ListMeta |

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a PodDisruptionBudget

### HTTP Request

`POST /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` PodDisruptionBudget |

### Response

Code | Description
--- | ---
202 PodDisruptionBudget | Accepted
200 PodDisruptionBudget | OK
201 PodDisruptionBudget | Created

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified PodDisruptionBudget

### HTTP Request

`PATCH /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PodDisruptionBudget
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 PodDisruptionBudget | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified PodDisruptionBudget

### HTTP Request

`PUT /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PodDisruptionBudget
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` PodDisruptionBudget |

### Response

Code | Description
--- | ---
200 PodDisruptionBudget | OK
201 PodDisruptionBudget | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a PodDisruptionBudget

### HTTP Request

`DELETE /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PodDisruptionBudget
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of PodDisruptionBudget

### HTTP Request

`DELETE /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified PodDisruptionBudget

### HTTP Request

`GET /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PodDisruptionBudget
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Response

Code | Description
--- | ---
200 PodDisruptionBudget | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind PodDisruptionBudget

### HTTP Request

`GET /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 PodDisruptionBudgetList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind PodDisruptionBudget

### HTTP Request

`GET /apis/policy/v1beta1/poddisruptionbudgets`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 PodDisruptionBudgetList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind PodDisruptionBudget

### HTTP Request

`GET /apis/policy/v1beta1/watch/namespaces/{namespace}/poddisruptionbudgets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PodDisruptionBudget
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of PodDisruptionBudget

### HTTP Request

`GET /apis/policy/v1beta1/watch/namespaces/{namespace}/poddisruptionbudgets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of PodDisruptionBudget

### HTTP Request

`GET /apis/policy/v1beta1/watch/poddisruptionbudgets`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Status Operations

See supported operations below...

## Patch Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update status of the specified PodDisruptionBudget

### HTTP Request

`PATCH /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PodDisruptionBudget
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 PodDisruptionBudget | OK

## Read Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read status of the specified PodDisruptionBudget

### HTTP Request

`GET /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PodDisruptionBudget
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 PodDisruptionBudget | OK

## Replace Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace status of the specified PodDisruptionBudget

### HTTP Request

`PUT /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PodDisruptionBudget
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` PodDisruptionBudget |

### Response

Code | Description
--- | ---
200 PodDisruptionBudget | OK
201 PodDisruptionBudget | Created

# PriorityClass v1alpha1 scheduling.k8s.io

Group | Version | Kind
--- | --- | ---
`scheduling.k8s.io` | `v1alpha1` | `PriorityClass`

Alpha objects should not be used in production and may not be compatible with future versions of the resource type.

PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer.

Appears In:

- PriorityClassList scheduling/v1alpha1

Field | Description
--- | ---
`apiVersion` string | 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
`description` string | description is an arbitrary string that usually provides guidelines on when this priority class should be used.
`globalDefault` boolean | globalDefault specifies whether this PriorityClass should be considered as the default priority for pods that do not have any priority class. Only one PriorityClass can be marked as `globalDefault`. However, if more than one PriorityClasses exists with their `globalDefault` field set to true, the smallest value of such global default PriorityClasses will be used as the default priority.
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`value` integer | 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.

### PriorityClassList v1alpha1 scheduling

Field | Description
--- | ---
`apiVersion` string | 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
`items` PriorityClass array | items is the list of PriorityClasses
`kind` string | 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
`metadata` ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a PriorityClass

### HTTP Request

`POST /apis/scheduling.k8s.io/v1alpha1/priorityclasses`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` PriorityClass |

### Response

Code | Description
--- | ---
200 PriorityClass | OK
201 PriorityClass | Created
202 PriorityClass | Accepted

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified PriorityClass

### HTTP Request

`PATCH /apis/scheduling.k8s.io/v1alpha1/priorityclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PriorityClass

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 PriorityClass | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified PriorityClass

### HTTP Request

`PUT /apis/scheduling.k8s.io/v1alpha1/priorityclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PriorityClass

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` PriorityClass |

### Response

Code | Description
--- | ---
200 PriorityClass | OK
201 PriorityClass | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a PriorityClass

### HTTP Request

`DELETE /apis/scheduling.k8s.io/v1alpha1/priorityclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PriorityClass

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of PriorityClass

### HTTP Request

`DELETE /apis/scheduling.k8s.io/v1alpha1/priorityclasses`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified PriorityClass

### HTTP Request

`GET /apis/scheduling.k8s.io/v1alpha1/priorityclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PriorityClass

### Query Parameters

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.

### Response

Code | Description
--- | ---
200 PriorityClass | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind PriorityClass

### HTTP Request

`GET /apis/scheduling.k8s.io/v1alpha1/priorityclasses`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 PriorityClassList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind PriorityClass

### HTTP Request

`GET /apis/scheduling.k8s.io/v1alpha1/watch/priorityclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PriorityClass

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of PriorityClass

### HTTP Request

`GET /apis/scheduling.k8s.io/v1alpha1/watch/priorityclasses`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

# PodPreset v1alpha1 settings.k8s.io

Group | Version | Kind
--- | --- | ---
`settings.k8s.io` | `v1alpha1` | `PodPreset`

Alpha objects should not be used in production and may not be compatible with future versions of the resource type.

PodPreset is a policy resource that defines additional runtime requirements for a Pod.

Appears In:

- PodPresetList settings/v1alpha1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta |
`spec` PodPresetSpec |

### PodPresetSpec v1alpha1 settings

Appears In:

- PodPreset settings/v1alpha1

Field | Description
--- | ---
`env` EnvVar array | Env defines the collection of EnvVar to inject into containers.
`envFrom` EnvFromSource array | EnvFrom defines the collection of EnvFromSource to inject into containers.
`selector` LabelSelector | Selector is a label query over a set of resources, in this case pods. Required.
`volumeMounts` VolumeMount array | VolumeMounts defines the collection of VolumeMount to inject into containers.
`volumes` Volume array | Volumes defines the collection of Volume to inject into the pod.

### PodPresetList v1alpha1 settings

Field | Description
--- | ---
`apiVersion` string | 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
`items` PodPreset array | Items is a list of schema objects.
`kind` string | 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
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a PodPreset

### HTTP Request

`POST /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` PodPreset |

### Response

Code | Description
--- | ---
201 PodPreset | Created
202 PodPreset | Accepted
200 PodPreset | OK

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified PodPreset

### HTTP Request

`PATCH /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PodPreset
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 PodPreset | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified PodPreset

### HTTP Request

`PUT /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PodPreset
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` PodPreset |

### Response

Code | Description
--- | ---
200 PodPreset | OK
201 PodPreset | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a PodPreset

### HTTP Request

`DELETE /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PodPreset
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of PodPreset

### HTTP Request

`DELETE /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified PodPreset

### HTTP Request

`GET /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PodPreset
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

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.

### Response

Code | Description
--- | ---
200 PodPreset | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind PodPreset

### HTTP Request

`GET /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 PodPresetList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind PodPreset

### HTTP Request

`GET /apis/settings.k8s.io/v1alpha1/podpresets`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 PodPresetList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind PodPreset

### HTTP Request

`GET /apis/settings.k8s.io/v1alpha1/watch/namespaces/{namespace}/podpresets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PodPreset
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of PodPreset

### HTTP Request

`GET /apis/settings.k8s.io/v1alpha1/watch/namespaces/{namespace}/podpresets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of PodPreset

### HTTP Request

`GET /apis/settings.k8s.io/v1alpha1/watch/podpresets`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

# PodSecurityPolicy v1beta1 extensions

Group | Version | Kind
--- | --- | ---
`extensions` | `v1beta1` | `PodSecurityPolicy`

Pod Security Policy governs the ability to make requests that affect the Security Context that will be applied to a pod and container.

Appears In:

- PodSecurityPolicyList extensions/v1beta1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`spec` PodSecurityPolicySpec | spec defines the policy enforced.

### PodSecurityPolicySpec v1beta1 extensions

Appears In:

- PodSecurityPolicy extensions/v1beta1

Field | Description
--- | ---
`allowPrivilegeEscalation` boolean | AllowPrivilegeEscalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true.
`allowedCapabilities` string array | AllowedCapabilities is a list of capabilities that can be requested to add to the container. Capabilities in this field may be added at the pod author's discretion. You must not list a capability in both AllowedCapabilities and RequiredDropCapabilities.
`allowedFlexVolumes` AllowedFlexVolume 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.
`allowedHostPaths` AllowedHostPath array | is a white list of allowed host paths. Empty indicates that all host paths may be used.
`defaultAddCapabilities` string array | DefaultAddCapabilities is the default set of capabilities that will be added to the container unless the pod spec specifically drops the capability. You may not list a capability in both DefaultAddCapabilities and RequiredDropCapabilities. Capabilities added here are implicitly allowed, and need not be included in the AllowedCapabilities list.
`defaultAllowPrivilegeEscalation` boolean | DefaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process.
`fsGroup` FSGroupStrategyOptions | FSGroup is the strategy that will dictate what fs group is used by the SecurityContext.
`hostIPC` boolean | hostIPC determines if the policy allows the use of HostIPC in the pod spec.
`hostNetwork` boolean | hostNetwork determines if the policy allows the use of HostNetwork in the pod spec.
`hostPID` boolean | hostPID determines if the policy allows the use of HostPID in the pod spec.
`hostPorts` HostPortRange array | hostPorts determines which host port ranges are allowed to be exposed.
`privileged` boolean | privileged determines if a pod can request to be run as privileged.
`readOnlyRootFilesystem` boolean | ReadOnlyRootFilesystem when set to true will force containers to run with a read only root file system. If the container specifically requests to run with a non-read only root file system the PSP should deny the pod. If set to false the container may run with a read only root file system if it wishes but it will not be forced to.
`requiredDropCapabilities` string array | RequiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added.
`runAsUser` RunAsUserStrategyOptions | runAsUser is the strategy that will dictate the allowable RunAsUser values that may be set.
`seLinux` SELinuxStrategyOptions | seLinux is the strategy that will dictate the allowable labels that may be set.
`supplementalGroups` SupplementalGroupsStrategyOptions | SupplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext.
`volumes` string array | volumes is a white list of allowed volume plugins. Empty indicates that all plugins may be used.

### PodSecurityPolicyList v1beta1 extensions

Field | Description
--- | ---
`apiVersion` string | 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
`items` PodSecurityPolicy array | Items is a list of schema objects.
`kind` string | 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
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a PodSecurityPolicy

### HTTP Request

`POST /apis/extensions/v1beta1/podsecuritypolicies`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` PodSecurityPolicy |

### Response

Code | Description
--- | ---
202 PodSecurityPolicy | Accepted
200 PodSecurityPolicy | OK
201 PodSecurityPolicy | Created

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified PodSecurityPolicy

### HTTP Request

`PATCH /apis/extensions/v1beta1/podsecuritypolicies/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PodSecurityPolicy

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 PodSecurityPolicy | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified PodSecurityPolicy

### HTTP Request

`PUT /apis/extensions/v1beta1/podsecuritypolicies/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PodSecurityPolicy

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` PodSecurityPolicy |

### Response

Code | Description
--- | ---
200 PodSecurityPolicy | OK
201 PodSecurityPolicy | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a PodSecurityPolicy

### HTTP Request

`DELETE /apis/extensions/v1beta1/podsecuritypolicies/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PodSecurityPolicy

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of PodSecurityPolicy

### HTTP Request

`DELETE /apis/extensions/v1beta1/podsecuritypolicies`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified PodSecurityPolicy

### HTTP Request

`GET /apis/extensions/v1beta1/podsecuritypolicies/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PodSecurityPolicy

### Query Parameters

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.

### Response

Code | Description
--- | ---
200 PodSecurityPolicy | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind PodSecurityPolicy

### HTTP Request

`GET /apis/extensions/v1beta1/podsecuritypolicies`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 PodSecurityPolicyList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind PodSecurityPolicy

### HTTP Request

`GET /apis/extensions/v1beta1/watch/podsecuritypolicies/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PodSecurityPolicy

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of PodSecurityPolicy

### HTTP Request

`GET /apis/extensions/v1beta1/watch/podsecuritypolicies`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

# CLUSTER

Cluster resources are responsible for defining configuration of the cluster itself, and are generally only used by cluster operators.

# APIService v1 apiregistration.k8s.io

Group | Version | Kind
--- | --- | ---
`apiregistration.k8s.io` | `v1` | `APIService`

Other api versions of this object exist: v1beta1

APIService represents a server for a particular GroupVersion. Name must be "version.group".

Appears In:

- APIServiceList apiregistration/v1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta |
`spec` APIServiceSpec | Spec contains information for locating and communicating with a server
`status` APIServiceStatus | Status contains derived information about an API server

### APIServiceSpec v1 apiregistration

Appears In:

- APIService apiregistration/v1

Field | Description
--- | ---
`caBundle` string | CABundle is a PEM encoded CA bundle which will be used to validate an API server's serving certificate.
`group` string | Group is the API group name this server hosts
`groupPriorityMinimum` integer | GroupPriorityMininum is the priority this group should have at least. Higher priority means that the group is preferred by clients over lower priority ones. Note that other versions of this group might specify even higher GroupPriorityMininum values such that the whole group gets a higher priority. The primary sort is based on GroupPriorityMinimum, ordered highest number to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) We'd recommend something like: *.k8s.io (except extensions) at 18000 and PaaSes (OpenShift, Deis) are recommended to be in the 2000s
`insecureSkipTLSVerify` boolean | InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. This is strongly discouraged. You should use the CABundle instead.
`service` ServiceReference | 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.
`version` string | Version is the API version this server hosts. For example, "v1"
`versionPriority` integer | VersionPriority controls the ordering of this API version inside of its group. Must be greater than zero. The primary sort is based on VersionPriority, ordered highest to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) Since it's inside of a group, the number can be small, probably in the 10s.

### APIServiceStatus v1 apiregistration

Appears In:

- APIService apiregistration/v1

Field | Description
--- | ---
`conditions` APIServiceCondition array patch type: merge patch merge key: type | Current service state of apiService.

### APIServiceList v1 apiregistration

Field | Description
--- | ---
`apiVersion` string | 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
`items` APIService array |
`kind` string | 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
`metadata` ListMeta |

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create an APIService

### HTTP Request

`POST /apis/apiregistration.k8s.io/v1/apiservices`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` APIService |

### Response

Code | Description
--- | ---
200 APIService | OK
201 APIService | Created
202 APIService | Accepted

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified APIService

### HTTP Request

`PATCH /apis/apiregistration.k8s.io/v1/apiservices/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the APIService

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 APIService | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified APIService

### HTTP Request

`PUT /apis/apiregistration.k8s.io/v1/apiservices/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the APIService

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` APIService |

### Response

Code | Description
--- | ---
201 APIService | Created
200 APIService | OK

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete an APIService

### HTTP Request

`DELETE /apis/apiregistration.k8s.io/v1/apiservices/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the APIService

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of APIService

### HTTP Request

`DELETE /apis/apiregistration.k8s.io/v1/apiservices`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified APIService

### HTTP Request

`GET /apis/apiregistration.k8s.io/v1/apiservices/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the APIService

### Query Parameters

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.

### Response

Code | Description
--- | ---
200 APIService | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind APIService

### HTTP Request

`GET /apis/apiregistration.k8s.io/v1/apiservices`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 APIServiceList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind APIService

### HTTP Request

`GET /apis/apiregistration.k8s.io/v1/watch/apiservices/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the APIService

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of APIService

### HTTP Request

`GET /apis/apiregistration.k8s.io/v1/watch/apiservices`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Status Operations

See supported operations below...

## Replace Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace status of the specified APIService

### HTTP Request

`PUT /apis/apiregistration.k8s.io/v1/apiservices/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the APIService

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` APIService |

### Response

Code | Description
--- | ---
201 APIService | Created
200 APIService | OK

# Binding v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `Binding`

Binding ties one object to another; for example, a pod is bound to a node by a scheduler. Deprecated in 1.7, please use the bindings subresource of pods instead.

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`target` ObjectReference | The target object that you want to bind to the standard object.

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a Binding

### HTTP Request

`POST /api/v1/namespaces/{namespace}/bindings`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Binding |

### Response

Code | Description
--- | ---
201 Binding | Created
202 Binding | Accepted
200 Binding | OK

# CertificateSigningRequest v1beta1 certificates.k8s.io

Group | Version | Kind
--- | --- | ---
`certificates.k8s.io` | `v1beta1` | `CertificateSigningRequest`

Describes a certificate signing request

Appears In:

- CertificateSigningRequestList certificates/v1beta1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta |
`spec` CertificateSigningRequestSpec | The certificate request itself and any additional information.
`status` CertificateSigningRequestStatus | Derived information about the request.

### CertificateSigningRequestSpec v1beta1 certificates

Appears In:

- CertificateSigningRequest certificates/v1beta1

Field | Description
--- | ---
`extra` object | Extra information about the requesting user. See user.Info interface for details.
`groups` string array | Group information about the requesting user. See user.Info interface for details.
`request` string | Base64-encoded PKCS#10 CSR data
`uid` string | UID information about the requesting user. See user.Info interface for details.
`usages` string 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
`username` string | Information about the requesting user. See user.Info interface for details.

### CertificateSigningRequestStatus v1beta1 certificates

Appears In:

- CertificateSigningRequest certificates/v1beta1

Field | Description
--- | ---
`certificate` string | If request was approved, the controller will place the issued certificate here.
`conditions` CertificateSigningRequestCondition array | Conditions applied to the request, such as approval or denial.

### CertificateSigningRequestList v1beta1 certificates

Field | Description
--- | ---
`apiVersion` string | 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
`items` CertificateSigningRequest array |
`kind` string | 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
`metadata` ListMeta |

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a CertificateSigningRequest

### HTTP Request

`POST /apis/certificates.k8s.io/v1beta1/certificatesigningrequests`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` CertificateSigningRequest |

### Response

Code | Description
--- | ---
200 CertificateSigningRequest | OK
201 CertificateSigningRequest | Created
202 CertificateSigningRequest | Accepted

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified CertificateSigningRequest

### HTTP Request

`PATCH /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CertificateSigningRequest

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 CertificateSigningRequest | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified CertificateSigningRequest

### HTTP Request

`PUT /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CertificateSigningRequest

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` CertificateSigningRequest |

### Response

Code | Description
--- | ---
200 CertificateSigningRequest | OK
201 CertificateSigningRequest | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a CertificateSigningRequest

### HTTP Request

`DELETE /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CertificateSigningRequest

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of CertificateSigningRequest

### HTTP Request

`DELETE /apis/certificates.k8s.io/v1beta1/certificatesigningrequests`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified CertificateSigningRequest

### HTTP Request

`GET /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CertificateSigningRequest

### Query Parameters

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.

### Response

Code | Description
--- | ---
200 CertificateSigningRequest | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind CertificateSigningRequest

### HTTP Request

`GET /apis/certificates.k8s.io/v1beta1/certificatesigningrequests`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 CertificateSigningRequestList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind CertificateSigningRequest

### HTTP Request

`GET /apis/certificates.k8s.io/v1beta1/watch/certificatesigningrequests/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CertificateSigningRequest

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of CertificateSigningRequest

### HTTP Request

`GET /apis/certificates.k8s.io/v1beta1/watch/certificatesigningrequests`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Status Operations

See supported operations below...

## Replace Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace status of the specified CertificateSigningRequest

### HTTP Request

`PUT /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CertificateSigningRequest

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` CertificateSigningRequest |

### Response

Code | Description
--- | ---
200 CertificateSigningRequest | OK
201 CertificateSigningRequest | Created

# ClusterRole v1 rbac.authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`rbac.authorization.k8s.io` | `v1` | `ClusterRole`

Other api versions of this object exist: v1beta1 v1alpha1

ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding.

Appears In:

- ClusterRoleList rbac/v1

Field | Description
--- | ---
`aggregationRule` AggregationRule | 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.
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata.
`rules` PolicyRule array | Rules holds all the PolicyRules for this ClusterRole

### ClusterRoleList v1 rbac

Field | Description
--- | ---
`apiVersion` string | 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
`items` ClusterRole array | Items is a list of ClusterRoles
`kind` string | 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
`metadata` ListMeta | Standard object's metadata.

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a ClusterRole

### HTTP Request

`POST /apis/rbac.authorization.k8s.io/v1/clusterroles`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ClusterRole |

### Response

Code | Description
--- | ---
200 ClusterRole | OK
201 ClusterRole | Created
202 ClusterRole | Accepted

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified ClusterRole

### HTTP Request

`PATCH /apis/rbac.authorization.k8s.io/v1/clusterroles/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ClusterRole

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 ClusterRole | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified ClusterRole

### HTTP Request

`PUT /apis/rbac.authorization.k8s.io/v1/clusterroles/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ClusterRole

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ClusterRole |

### Response

Code | Description
--- | ---
200 ClusterRole | OK
201 ClusterRole | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a ClusterRole

### HTTP Request

`DELETE /apis/rbac.authorization.k8s.io/v1/clusterroles/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ClusterRole

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of ClusterRole

### HTTP Request

`DELETE /apis/rbac.authorization.k8s.io/v1/clusterroles`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified ClusterRole

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1/clusterroles/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ClusterRole

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 ClusterRole | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind ClusterRole

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1/clusterroles`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 ClusterRoleList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind ClusterRole

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1/watch/clusterroles/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ClusterRole

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of ClusterRole

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1/watch/clusterroles`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

# ClusterRoleBinding v1 rbac.authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`rbac.authorization.k8s.io` | `v1` | `ClusterRoleBinding`

Other api versions of this object exist: v1beta1 v1alpha1

ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject.

Appears In:

- ClusterRoleBindingList rbac/v1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata.
`roleRef` RoleRef | RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
`subjects` Subject array | Subjects holds references to the objects the role applies to.

### ClusterRoleBindingList v1 rbac

Field | Description
--- | ---
`apiVersion` string | 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
`items` ClusterRoleBinding array | Items is a list of ClusterRoleBindings
`kind` string | 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
`metadata` ListMeta | Standard object's metadata.

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a ClusterRoleBinding

### HTTP Request

`POST /apis/rbac.authorization.k8s.io/v1/clusterrolebindings`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ClusterRoleBinding |

### Response

Code | Description
--- | ---
200 ClusterRoleBinding | OK
201 ClusterRoleBinding | Created
202 ClusterRoleBinding | Accepted

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified ClusterRoleBinding

### HTTP Request

`PATCH /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ClusterRoleBinding

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 ClusterRoleBinding | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified ClusterRoleBinding

### HTTP Request

`PUT /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ClusterRoleBinding

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ClusterRoleBinding |

### Response

Code | Description
--- | ---
200 ClusterRoleBinding | OK
201 ClusterRoleBinding | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a ClusterRoleBinding

### HTTP Request

`DELETE /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ClusterRoleBinding

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of ClusterRoleBinding

### HTTP Request

`DELETE /apis/rbac.authorization.k8s.io/v1/clusterrolebindings`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified ClusterRoleBinding

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ClusterRoleBinding

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 ClusterRoleBinding | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind ClusterRoleBinding

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1/clusterrolebindings`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 ClusterRoleBindingList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind ClusterRoleBinding

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1/watch/clusterrolebindings/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ClusterRoleBinding

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of ClusterRoleBinding

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1/watch/clusterrolebindings`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

# ComponentStatus v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `ComponentStatus`

ComponentStatus (and ComponentStatusList) holds the cluster validation info.

Appears In:

- ComponentStatusList core/v1

Field | Description
--- | ---
`apiVersion` string | 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
`conditions` ComponentCondition array patch type: merge patch merge key: type | List of component conditions observed
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

### ComponentStatusList v1 core

Field | Description
--- | ---
`apiVersion` string | 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
`items` ComponentStatus array | List of ComponentStatus objects.
`kind` string | 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
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified ComponentStatus

### HTTP Request

`GET /api/v1/componentstatuses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ComponentStatus

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 ComponentStatus | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list objects of kind ComponentStatus

### HTTP Request

`GET /api/v1/componentstatuses`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 ComponentStatusList | OK

# LocalSubjectAccessReview v1 authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`authorization.k8s.io` | `v1` | `LocalSubjectAccessReview`

Other api versions of this object exist: v1beta1

LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace. Having a namespace scoped resource makes it much easier to grant namespace scoped policy that includes permissions checking.

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta |
`spec` SubjectAccessReviewSpec | 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.
`status` SubjectAccessReviewStatus | Status is filled in by the server and indicates whether the request is allowed or not

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a LocalSubjectAccessReview

### HTTP Request

`POST /apis/authorization.k8s.io/v1/namespaces/{namespace}/localsubjectaccessreviews`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` LocalSubjectAccessReview |

### Response

Code | Description
--- | ---
200 LocalSubjectAccessReview | OK
201 LocalSubjectAccessReview | Created
202 LocalSubjectAccessReview | Accepted

# Namespace v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `Namespace`

Namespace provides a scope for Names. Use of multiple namespaces is optional.

Appears In:

- NamespaceList core/v1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`spec` NamespaceSpec | Spec defines the behavior of the Namespace. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
`status` NamespaceStatus | Status describes the current status of a Namespace. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

### NamespaceSpec v1 core

Appears In:

- Namespace core/v1

Field | Description
--- | ---
`finalizers` string 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/

### NamespaceStatus v1 core

Appears In:

- Namespace core/v1

Field | Description
--- | ---
`phase` string | Phase is the current lifecycle phase of the namespace. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/

### NamespaceList v1 core

Field | Description
--- | ---
`apiVersion` string | 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
`items` Namespace array | Items is the list of Namespace objects in the list. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
`kind` string | 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
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a Namespace

### HTTP Request

`POST /api/v1/namespaces`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Namespace |

### Response

Code | Description
--- | ---
201 Namespace | Created
202 Namespace | Accepted
200 Namespace | OK

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified Namespace

### HTTP Request

`PATCH /api/v1/namespaces/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Namespace

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 Namespace | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified Namespace

### HTTP Request

`PUT /api/v1/namespaces/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Namespace

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Namespace |

### Response

Code | Description
--- | ---
200 Namespace | OK
201 Namespace | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a Namespace

### HTTP Request

`DELETE /api/v1/namespaces/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Namespace

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified Namespace

### HTTP Request

`GET /api/v1/namespaces/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Namespace

### Query Parameters

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.

### Response

Code | Description
--- | ---
200 Namespace | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind Namespace

### HTTP Request

`GET /api/v1/namespaces`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 NamespaceList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind Namespace

### HTTP Request

`GET /api/v1/watch/namespaces/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Namespace

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of Namespace

### HTTP Request

`GET /api/v1/watch/namespaces`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Status Operations

See supported operations below...

## Patch Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update status of the specified Namespace

### HTTP Request

`PATCH /api/v1/namespaces/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Namespace

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 Namespace | OK

## Read Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read status of the specified Namespace

### HTTP Request

`GET /api/v1/namespaces/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Namespace

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 Namespace | OK

## Replace Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace status of the specified Namespace

### HTTP Request

`PUT /api/v1/namespaces/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Namespace

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Namespace |

### Response

Code | Description
--- | ---
200 Namespace | OK
201 Namespace | Created

# Node v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `Node`

Node is a worker node in Kubernetes. Each node will have a unique identifier in the cache (i.e. in etcd).

Appears In:

- NodeList core/v1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`spec` NodeSpec | Spec defines the behavior of a node. https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
`status` NodeStatus | 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

### NodeSpec v1 core

Appears In:

- Node core/v1

Field | Description
--- | ---
`configSource` NodeConfigSource | If specified, the source to get node configuration from The DynamicKubeletConfig feature gate must be enabled for the Kubelet to use this field
`externalID` string | External ID of the node assigned by some machine database (e.g. a cloud provider). Deprecated.
`podCIDR` string | PodCIDR represents the pod IP range assigned to the node.
`providerID` string | ID of the node assigned by the cloud provider in the format: <ProviderName>://<ProviderSpecificNodeID>
`taints` Taint array | If specified, the node's taints.
`unschedulable` boolean | Unschedulable controls node schedulability of new pods. By default, node is schedulable. More info: https://kubernetes.io/docs/concepts/nodes/node/#manual-node-administration

### NodeStatus v1 core

Appears In:

- Node core/v1

Field | Description
--- | ---
`addresses` NodeAddress array patch type: 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
`allocatable` object | Allocatable represents the resources of a node that are available for scheduling. Defaults to Capacity.
`capacity` object | Capacity represents the total resources of a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity
`conditions` NodeCondition array patch type: merge patch merge key: type | Conditions is an array of current observed node conditions. More info: https://kubernetes.io/docs/concepts/nodes/node/#condition
`daemonEndpoints` NodeDaemonEndpoints | Endpoints of daemons running on the Node.
`images` ContainerImage array | List of container images on this node
`nodeInfo` NodeSystemInfo | Set of ids/uuids to uniquely identify the node. More info: https://kubernetes.io/docs/concepts/nodes/node/#info
`phase` string | 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.
`volumesAttached` AttachedVolume array | List of volumes that are attached to the node.
`volumesInUse` string array | List of attachable volumes in use (mounted) by the node.

### NodeList v1 core

Field | Description
--- | ---
`apiVersion` string | 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
`items` Node array | List of nodes
`kind` string | 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
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a Node

### HTTP Request

`POST /api/v1/nodes`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Node |

### Response

Code | Description
--- | ---
202 Node | Accepted
200 Node | OK
201 Node | Created

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified Node

### HTTP Request

`PATCH /api/v1/nodes/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Node

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 Node | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified Node

### HTTP Request

`PUT /api/v1/nodes/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Node

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Node |

### Response

Code | Description
--- | ---
200 Node | OK
201 Node | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a Node

### HTTP Request

`DELETE /api/v1/nodes/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Node

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of Node

### HTTP Request

`DELETE /api/v1/nodes`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified Node

### HTTP Request

`GET /api/v1/nodes/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Node

### Query Parameters

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.

### Response

Code | Description
--- | ---
200 Node | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind Node

### HTTP Request

`GET /api/v1/nodes`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 NodeList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind Node

### HTTP Request

`GET /api/v1/watch/nodes/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Node

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of Node

### HTTP Request

`GET /api/v1/watch/nodes`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Status Operations

See supported operations below...

## Patch Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update status of the specified Node

### HTTP Request

`PATCH /api/v1/nodes/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Node

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 Node | OK

## Read Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read status of the specified Node

### HTTP Request

`GET /api/v1/nodes/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Node

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 Node | OK

## Replace Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace status of the specified Node

### HTTP Request

`PUT /api/v1/nodes/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Node

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Node |

### Response

Code | Description
--- | ---
200 Node | OK
201 Node | Created

## Proxy Operations

See supported operations below...

## Create Connect Proxy

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

connect POST requests to proxy of Node

### HTTP Request

`POST /api/v1/nodes/{name}/proxy`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Node

### Query Parameters

Parameter | Description
--- | ---
`path` | Path is the URL path to use for the current proxy request to node.

### Response

Code | Description
--- | ---
200 string | OK

## Create Connect Proxy Path

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

connect POST requests to proxy of Node

### HTTP Request

`POST /api/v1/nodes/{name}/proxy/{path}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Node
`path` | path to the resource

### Query Parameters

Parameter | Description
--- | ---
`path` | Path is the URL path to use for the current proxy request to node.

### Response

Code | Description
--- | ---
200 string | OK

## Delete Connect Proxy

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

connect DELETE requests to proxy of Node

### HTTP Request

`DELETE /api/v1/nodes/{name}/proxy`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Node

### Query Parameters

Parameter | Description
--- | ---
`path` | Path is the URL path to use for the current proxy request to node.

### Response

Code | Description
--- | ---
200 string | OK

## Delete Connect Proxy Path

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

connect DELETE requests to proxy of Node

### HTTP Request

`DELETE /api/v1/nodes/{name}/proxy/{path}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Node
`path` | path to the resource

### Query Parameters

Parameter | Description
--- | ---
`path` | Path is the URL path to use for the current proxy request to node.

### Response

Code | Description
--- | ---
200 string | OK

## Get Connect Proxy

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

connect GET requests to proxy of Node

### HTTP Request

`GET /api/v1/nodes/{name}/proxy`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Node

### Query Parameters

Parameter | Description
--- | ---
`path` | Path is the URL path to use for the current proxy request to node.

### Response

Code | Description
--- | ---
200 string | OK

## Get Connect Proxy Path

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

connect GET requests to proxy of Node

### HTTP Request

`GET /api/v1/nodes/{name}/proxy/{path}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Node
`path` | path to the resource

### Query Parameters

Parameter | Description
--- | ---
`path` | Path is the URL path to use for the current proxy request to node.

### Response

Code | Description
--- | ---
200 string | OK

## Head Connect Proxy

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

connect HEAD requests to proxy of Node

### HTTP Request

`HEAD /api/v1/nodes/{name}/proxy`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Node

### Query Parameters

Parameter | Description
--- | ---
`path` | Path is the URL path to use for the current proxy request to node.

### Response

Code | Description
--- | ---
200 string | OK

## Head Connect Proxy Path

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

connect HEAD requests to proxy of Node

### HTTP Request

`HEAD /api/v1/nodes/{name}/proxy/{path}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Node
`path` | path to the resource

### Query Parameters

Parameter | Description
--- | ---
`path` | Path is the URL path to use for the current proxy request to node.

### Response

Code | Description
--- | ---
200 string | OK

## Replace Connect Proxy

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

connect PUT requests to proxy of Node

### HTTP Request

`PUT /api/v1/nodes/{name}/proxy`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Node

### Query Parameters

Parameter | Description
--- | ---
`path` | Path is the URL path to use for the current proxy request to node.

### Response

Code | Description
--- | ---
200 string | OK

## Replace Connect Proxy Path

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

connect PUT requests to proxy of Node

### HTTP Request

`PUT /api/v1/nodes/{name}/proxy/{path}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Node
`path` | path to the resource

### Query Parameters

Parameter | Description
--- | ---
`path` | Path is the URL path to use for the current proxy request to node.

### Response

Code | Description
--- | ---
200 string | OK

# PersistentVolume v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `PersistentVolume`

These are assigned to Pods using PersistentVolumeClaims.

PersistentVolume (PV) is a storage resource provisioned by an administrator. It is analogous to a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes

Appears In:

- PersistentVolumeList core/v1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`spec` PersistentVolumeSpec | 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
`status` PersistentVolumeStatus | 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

### PersistentVolumeSpec v1 core

Appears In:

- PersistentVolume core/v1

Field | Description
--- | ---
`accessModes` string array | AccessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes
`awsElasticBlockStore` AWSElasticBlockStoreVolumeSource | 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
`azureDisk` AzureDiskVolumeSource | AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
`azureFile` AzureFilePersistentVolumeSource | AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
`capacity` object | A description of the persistent volume's resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity
`cephfs` CephFSPersistentVolumeSource | CephFS represents a Ceph FS mount on the host that shares a pod's lifetime
`cinder` CinderVolumeSource | 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
`claimRef` ObjectReference | 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
`csi` CSIPersistentVolumeSource | CSI represents storage that handled by an external CSI driver (Beta feature).
`fc` FCVolumeSource | FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
`flexVolume` FlexPersistentVolumeSource | FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
`flocker` FlockerVolumeSource | 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
`gcePersistentDisk` GCEPersistentDiskVolumeSource | 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
`glusterfs` GlusterfsVolumeSource | 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
`hostPath` HostPathVolumeSource | 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
`iscsi` ISCSIPersistentVolumeSource | 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.
`local` LocalVolumeSource | Local represents directly-attached storage with node affinity
`mountOptions` string 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
`nfs` NFSVolumeSource | NFS represents an NFS mount on the host. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
`nodeAffinity` VolumeNodeAffinity | NodeAffinity defines constraints that limit what nodes this volume can be accessed from. This field influences the scheduling of pods that use this volume.
`persistentVolumeReclaimPolicy` string | What happens to a persistent volume when released from its claim. Valid options are Retain (default for manually created PersistentVolumes), Delete (default for dynamically provisioned PersistentVolumes), and Recycle (deprecated). Recycle must be supported by the volume plugin underlying this PersistentVolume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming
`photonPersistentDisk` PhotonPersistentDiskVolumeSource | PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
`portworxVolume` PortworxVolumeSource | PortworxVolume represents a portworx volume attached and mounted on kubelets host machine
`quobyte` QuobyteVolumeSource | Quobyte represents a Quobyte mount on the host that shares a pod's lifetime
`rbd` RBDPersistentVolumeSource | 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
`scaleIO` ScaleIOPersistentVolumeSource | ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
`storageClassName` string | Name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass.
`storageos` StorageOSPersistentVolumeSource | 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
`volumeMode` string | volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. Value of Filesystem is implied when not included in spec. This is an alpha feature and may change in the future.
`vsphereVolume` VsphereVirtualDiskVolumeSource | VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

### PersistentVolumeStatus v1 core

Appears In:

- PersistentVolume core/v1

Field | Description
--- | ---
`message` string | A human-readable message indicating details about why the volume is in this state.
`phase` string | 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
`reason` string | Reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI.

### PersistentVolumeList v1 core

Field | Description
--- | ---
`apiVersion` string | 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
`items` PersistentVolume array | List of persistent volumes. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes
`kind` string | 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
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a PersistentVolume

### HTTP Request

`POST /api/v1/persistentvolumes`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` PersistentVolume |

### Response

Code | Description
--- | ---
200 PersistentVolume | OK
201 PersistentVolume | Created
202 PersistentVolume | Accepted

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified PersistentVolume

### HTTP Request

`PATCH /api/v1/persistentvolumes/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PersistentVolume

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 PersistentVolume | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified PersistentVolume

### HTTP Request

`PUT /api/v1/persistentvolumes/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PersistentVolume

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` PersistentVolume |

### Response

Code | Description
--- | ---
200 PersistentVolume | OK
201 PersistentVolume | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a PersistentVolume

### HTTP Request

`DELETE /api/v1/persistentvolumes/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PersistentVolume

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of PersistentVolume

### HTTP Request

`DELETE /api/v1/persistentvolumes`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified PersistentVolume

### HTTP Request

`GET /api/v1/persistentvolumes/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PersistentVolume

### Query Parameters

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.

### Response

Code | Description
--- | ---
200 PersistentVolume | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind PersistentVolume

### HTTP Request

`GET /api/v1/persistentvolumes`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 PersistentVolumeList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind PersistentVolume

### HTTP Request

`GET /api/v1/watch/persistentvolumes/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PersistentVolume

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of PersistentVolume

### HTTP Request

`GET /api/v1/watch/persistentvolumes`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Status Operations

See supported operations below...

## Patch Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update status of the specified PersistentVolume

### HTTP Request

`PATCH /api/v1/persistentvolumes/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PersistentVolume

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 PersistentVolume | OK

## Read Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read status of the specified PersistentVolume

### HTTP Request

`GET /api/v1/persistentvolumes/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PersistentVolume

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 PersistentVolume | OK

## Replace Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace status of the specified PersistentVolume

### HTTP Request

`PUT /api/v1/persistentvolumes/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PersistentVolume

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` PersistentVolume |

### Response

Code | Description
--- | ---
200 PersistentVolume | OK
201 PersistentVolume | Created

# ResourceQuota v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `ResourceQuota`

ResourceQuota sets aggregate quota restrictions enforced per namespace

Appears In:

- ResourceQuotaList core/v1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`spec` ResourceQuotaSpec | Spec defines the desired quota. https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
`status` ResourceQuotaStatus | Status defines the actual enforced quota and its current usage. https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

### ResourceQuotaSpec v1 core

Appears In:

- ResourceQuota core/v1

Field | Description
--- | ---
`hard` object | Hard is the set of desired hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/
`scopes` string array | A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects.

### ResourceQuotaStatus v1 core

Appears In:

- ResourceQuota core/v1

Field | Description
--- | ---
`hard` object | Hard is the set of enforced hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/
`used` object | Used is the current observed total usage of the resource in the namespace.

### ResourceQuotaList v1 core

Field | Description
--- | ---
`apiVersion` string | 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
`items` ResourceQuota array | Items is a list of ResourceQuota objects. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/
`kind` string | 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
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a ResourceQuota

### HTTP Request

`POST /api/v1/namespaces/{namespace}/resourcequotas`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ResourceQuota |

### Response

Code | Description
--- | ---
200 ResourceQuota | OK
201 ResourceQuota | Created
202 ResourceQuota | Accepted

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified ResourceQuota

### HTTP Request

`PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ResourceQuota
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 ResourceQuota | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified ResourceQuota

### HTTP Request

`PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ResourceQuota
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ResourceQuota |

### Response

Code | Description
--- | ---
200 ResourceQuota | OK
201 ResourceQuota | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a ResourceQuota

### HTTP Request

`DELETE /api/v1/namespaces/{namespace}/resourcequotas/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ResourceQuota
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of ResourceQuota

### HTTP Request

`DELETE /api/v1/namespaces/{namespace}/resourcequotas`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified ResourceQuota

### HTTP Request

`GET /api/v1/namespaces/{namespace}/resourcequotas/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ResourceQuota
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Response

Code | Description
--- | ---
200 ResourceQuota | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind ResourceQuota

### HTTP Request

`GET /api/v1/namespaces/{namespace}/resourcequotas`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 ResourceQuotaList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind ResourceQuota

### HTTP Request

`GET /api/v1/resourcequotas`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 ResourceQuotaList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind ResourceQuota

### HTTP Request

`GET /api/v1/watch/namespaces/{namespace}/resourcequotas/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ResourceQuota
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of ResourceQuota

### HTTP Request

`GET /api/v1/watch/namespaces/{namespace}/resourcequotas`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of ResourceQuota

### HTTP Request

`GET /api/v1/watch/resourcequotas`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Status Operations

See supported operations below...

## Patch Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update status of the specified ResourceQuota

### HTTP Request

`PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ResourceQuota
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 ResourceQuota | OK

## Read Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read status of the specified ResourceQuota

### HTTP Request

`GET /api/v1/namespaces/{namespace}/resourcequotas/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ResourceQuota
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 ResourceQuota | OK

## Replace Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace status of the specified ResourceQuota

### HTTP Request

`PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ResourceQuota
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ResourceQuota |

### Response

Code | Description
--- | ---
200 ResourceQuota | OK
201 ResourceQuota | Created

# Role v1 rbac.authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`rbac.authorization.k8s.io` | `v1` | `Role`

Other api versions of this object exist: v1beta1 v1alpha1

Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding.

Appears In:

- RoleList rbac/v1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata.
`rules` PolicyRule array | Rules holds all the PolicyRules for this Role

### RoleList v1 rbac

Field | Description
--- | ---
`apiVersion` string | 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
`items` Role array | Items is a list of Roles
`kind` string | 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
`metadata` ListMeta | Standard object's metadata.

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a Role

### HTTP Request

`POST /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Role |

### Response

Code | Description
--- | ---
200 Role | OK
201 Role | Created
202 Role | Accepted

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified Role

### HTTP Request

`PATCH /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Role
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 Role | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified Role

### HTTP Request

`PUT /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Role
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Role |

### Response

Code | Description
--- | ---
200 Role | OK
201 Role | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a Role

### HTTP Request

`DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Role
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of Role

### HTTP Request

`DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified Role

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Role
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 Role | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind Role

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 RoleList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind Role

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1/roles`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 RoleList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind Role

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/roles/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Role
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of Role

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/roles`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of Role

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1/watch/roles`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

# RoleBinding v1 rbac.authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`rbac.authorization.k8s.io` | `v1` | `RoleBinding`

Other api versions of this object exist: v1beta1 v1alpha1

RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace.

Appears In:

- RoleBindingList rbac/v1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata.
`roleRef` RoleRef | 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.
`subjects` Subject array | Subjects holds references to the objects the role applies to.

### RoleBindingList v1 rbac

Field | Description
--- | ---
`apiVersion` string | 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
`items` RoleBinding array | Items is a list of RoleBindings
`kind` string | 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
`metadata` ListMeta | Standard object's metadata.

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a RoleBinding

### HTTP Request

`POST /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` RoleBinding |

### Response

Code | Description
--- | ---
200 RoleBinding | OK
201 RoleBinding | Created
202 RoleBinding | Accepted

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified RoleBinding

### HTTP Request

`PATCH /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the RoleBinding
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 RoleBinding | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified RoleBinding

### HTTP Request

`PUT /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the RoleBinding
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` RoleBinding |

### Response

Code | Description
--- | ---
200 RoleBinding | OK
201 RoleBinding | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a RoleBinding

### HTTP Request

`DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the RoleBinding
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of RoleBinding

### HTTP Request

`DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified RoleBinding

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the RoleBinding
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 RoleBinding | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind RoleBinding

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 RoleBindingList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind RoleBinding

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1/rolebindings`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 RoleBindingList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind RoleBinding

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/rolebindings/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the RoleBinding
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of RoleBinding

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/rolebindings`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of RoleBinding

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1/watch/rolebindings`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

# SelfSubjectAccessReview v1 authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`authorization.k8s.io` | `v1` | `SelfSubjectAccessReview`

Other api versions of this object exist: v1beta1

SelfSubjectAccessReview checks whether or the current user can perform an action. Not filling in a spec.namespace means "in all namespaces". Self is a special case, because users should always be able to check whether they can perform an action

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta |
`spec` SelfSubjectAccessReviewSpec | Spec holds information about the request being evaluated. user and groups must be empty
`status` SubjectAccessReviewStatus | Status is filled in by the server and indicates whether the request is allowed or not

### SelfSubjectAccessReviewSpec v1 authorization

Appears In:

- SelfSubjectAccessReview authorization/v1

Field | Description
--- | ---
`nonResourceAttributes` NonResourceAttributes | NonResourceAttributes describes information for a non-resource access request
`resourceAttributes` ResourceAttributes | ResourceAuthorizationAttributes describes information for a resource access request

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a SelfSubjectAccessReview

### HTTP Request

`POST /apis/authorization.k8s.io/v1/selfsubjectaccessreviews`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` SelfSubjectAccessReview |

### Response

Code | Description
--- | ---
201 SelfSubjectAccessReview | Created
202 SelfSubjectAccessReview | Accepted
200 SelfSubjectAccessReview | OK

# SelfSubjectRulesReview v1 authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`authorization.k8s.io` | `v1` | `SelfSubjectRulesReview`

Other api versions of this object exist: v1beta1

SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace. The returned list of actions may be incomplete depending on the server's authorization mode, and any errors experienced during the evaluation. SelfSubjectRulesReview should be used by UIs to show/hide actions, or to quickly let an end user reason about their permissions. It should NOT Be used by external systems to drive authorization decisions as this raises confused deputy, cache lifetime/revocation, and correctness concerns. SubjectAccessReview, and LocalAccessReview are the correct way to defer authorization decisions to the API server.

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta |
`spec` SelfSubjectRulesReviewSpec | Spec holds information about the request being evaluated.
`status` SubjectRulesReviewStatus | Status is filled in by the server and indicates the set of actions a user can perform.

### SelfSubjectRulesReviewSpec v1 authorization

Appears In:

- SelfSubjectRulesReview authorization/v1

Field | Description
--- | ---
`namespace` string | Namespace to evaluate rules for. Required.

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a SelfSubjectRulesReview

### HTTP Request

`POST /apis/authorization.k8s.io/v1/selfsubjectrulesreviews`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` SelfSubjectRulesReview |

### Response

Code | Description
--- | ---
200 SelfSubjectRulesReview | OK
201 SelfSubjectRulesReview | Created
202 SelfSubjectRulesReview | Accepted

# ServiceAccount v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `ServiceAccount`

ServiceAccount binds together: a name, understood by users, and perhaps by peripheral systems, for an identity a principal that can be authenticated and authorized * a set of secrets

Appears In:

- ServiceAccountList core/v1

Field | Description
--- | ---
`apiVersion` string | 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
`automountServiceAccountToken` boolean | AutomountServiceAccountToken indicates whether pods running as this service account should have an API token automatically mounted. Can be overridden at the pod level.
`imagePullSecrets` LocalObjectReference 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
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`secrets` ObjectReference array patch type: 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

### ServiceAccountList v1 core

Field | Description
--- | ---
`apiVersion` string | 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
`items` ServiceAccount array | List of ServiceAccounts. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
`kind` string | 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
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a ServiceAccount

### HTTP Request

`POST /api/v1/namespaces/{namespace}/serviceaccounts`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ServiceAccount |

### Response

Code | Description
--- | ---
202 ServiceAccount | Accepted
200 ServiceAccount | OK
201 ServiceAccount | Created

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified ServiceAccount

### HTTP Request

`PATCH /api/v1/namespaces/{namespace}/serviceaccounts/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ServiceAccount
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 ServiceAccount | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified ServiceAccount

### HTTP Request

`PUT /api/v1/namespaces/{namespace}/serviceaccounts/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ServiceAccount
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ServiceAccount |

### Response

Code | Description
--- | ---
200 ServiceAccount | OK
201 ServiceAccount | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a ServiceAccount

### HTTP Request

`DELETE /api/v1/namespaces/{namespace}/serviceaccounts/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ServiceAccount
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of ServiceAccount

### HTTP Request

`DELETE /api/v1/namespaces/{namespace}/serviceaccounts`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified ServiceAccount

### HTTP Request

`GET /api/v1/namespaces/{namespace}/serviceaccounts/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ServiceAccount
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Response

Code | Description
--- | ---
200 ServiceAccount | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind ServiceAccount

### HTTP Request

`GET /api/v1/namespaces/{namespace}/serviceaccounts`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 ServiceAccountList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind ServiceAccount

### HTTP Request

`GET /api/v1/serviceaccounts`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 ServiceAccountList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind ServiceAccount

### HTTP Request

`GET /api/v1/watch/namespaces/{namespace}/serviceaccounts/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ServiceAccount
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of ServiceAccount

### HTTP Request

`GET /api/v1/watch/namespaces/{namespace}/serviceaccounts`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of ServiceAccount

### HTTP Request

`GET /api/v1/watch/serviceaccounts`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

# SubjectAccessReview v1 authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`authorization.k8s.io` | `v1` | `SubjectAccessReview`

Other api versions of this object exist: v1beta1

SubjectAccessReview checks whether or not a user or group can perform an action.

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta |
`spec` SubjectAccessReviewSpec | Spec holds information about the request being evaluated
`status` SubjectAccessReviewStatus | Status is filled in by the server and indicates whether the request is allowed or not

### SubjectAccessReviewSpec v1 authorization

Appears In:

- LocalSubjectAccessReview authorization/v1
- SubjectAccessReview authorization/v1

Field | Description
--- | ---
`extra` object | Extra corresponds to the user.Info.GetExtra() method from the authenticator. Since that is input to the authorizer it needs a reflection here.
`groups` string array | Groups is the groups you're testing for.
`nonResourceAttributes` NonResourceAttributes | NonResourceAttributes describes information for a non-resource access request
`resourceAttributes` ResourceAttributes | ResourceAuthorizationAttributes describes information for a resource access request
`uid` string | UID information about the requesting user.
`user` string | User is the user you're testing for. If you specify "User" but not "Groups", then is it interpreted as "What if User were not a member of any groups

### SubjectAccessReviewStatus v1 authorization

Appears In:

- LocalSubjectAccessReview authorization/v1
- SelfSubjectAccessReview authorization/v1
- SubjectAccessReview authorization/v1

Field | Description
--- | ---
`allowed` boolean | Allowed is required. True if the action would be allowed, false otherwise.
`denied` boolean | Denied is optional. True if the action would be denied, otherwise false. If both allowed is false and denied is false, then the authorizer has no opinion on whether to authorize the action. Denied may not be true if Allowed is true.
`evaluationError` string | EvaluationError is an indication that some error occurred during the authorization check. It is entirely possible to get an error and be able to continue determine authorization status in spite of it. For instance, RBAC can be missing a role, but enough roles are still present and bound to reason about the request.
`reason` string | Reason is optional. It indicates why a request was allowed or denied.

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a SubjectAccessReview

### HTTP Request

`POST /apis/authorization.k8s.io/v1/subjectaccessreviews`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` SubjectAccessReview |

### Response

Code | Description
--- | ---
202 SubjectAccessReview | Accepted
200 SubjectAccessReview | OK
201 SubjectAccessReview | Created

# TokenReview v1 authentication.k8s.io

Group | Version | Kind
--- | --- | ---
`authentication.k8s.io` | `v1` | `TokenReview`

Other api versions of this object exist: v1beta1

TokenReview attempts to authenticate a token to a known user. Note: TokenReview requests may be cached by the webhook token authenticator plugin in the kube-apiserver.

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta |
`spec` TokenReviewSpec | Spec holds information about the request being evaluated
`status` TokenReviewStatus | Status is filled in by the server and indicates whether the request can be authenticated.

### TokenReviewSpec v1 authentication

Appears In:

- TokenReview authentication/v1

Field | Description
--- | ---
`token` string | Token is the opaque bearer token.

### TokenReviewStatus v1 authentication

Appears In:

- TokenReview authentication/v1

Field | Description
--- | ---
`authenticated` boolean | Authenticated indicates that the token was associated with a known user.
`error` string | Error indicates that the token couldn't be checked
`user` UserInfo | User is the UserInfo associated with the provided token.

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a TokenReview

### HTTP Request

`POST /apis/authentication.k8s.io/v1/tokenreviews`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` TokenReview |

### Response

Code | Description
--- | ---
200 TokenReview | OK
201 TokenReview | Created
202 TokenReview | Accepted

# NetworkPolicy v1 networking.k8s.io

Group | Version | Kind
--- | --- | ---
`networking.k8s.io` | `v1` | `NetworkPolicy`

Other api versions of this object exist: v1beta1

NetworkPolicy describes what network traffic is allowed for a set of Pods

Appears In:

- NetworkPolicyList networking/v1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`spec` NetworkPolicySpec | Specification of the desired behavior for this NetworkPolicy.

### NetworkPolicySpec v1 networking

Appears In:

- NetworkPolicy networking/v1

Field | Description
--- | ---
`egress` NetworkPolicyEgressRule 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
`ingress` NetworkPolicyIngressRule 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)
`podSelector` LabelSelector | Selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace.
`policyTypes` string array | List of rule types that the NetworkPolicy relates to. Valid options are Ingress, Egress, or Ingress,Egress. If this field is not specified, it will default based on the existence of Ingress or Egress rules; policies that contain an Egress section are assumed to affect Egress, and all policies (whether or not they contain an Ingress section) are assumed to affect Ingress. If you want to write an egress-only policy, you must explicitly specify policyTypes [ "Egress" ]. Likewise, if you want to write a policy that specifies that no egress is allowed, you must specify a policyTypes value that include "Egress" (since such a policy would not include an Egress section and would otherwise default to just [ "Ingress" ]). This field is beta-level in 1.8

### NetworkPolicyList v1 networking

Field | Description
--- | ---
`apiVersion` string | 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
`items` NetworkPolicy array | Items is a list of schema objects.
`kind` string | 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
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a NetworkPolicy

### HTTP Request

`POST /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` NetworkPolicy |

### Response

Code | Description
--- | ---
201 NetworkPolicy | Created
202 NetworkPolicy | Accepted
200 NetworkPolicy | OK

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified NetworkPolicy

### HTTP Request

`PATCH /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the NetworkPolicy
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 NetworkPolicy | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified NetworkPolicy

### HTTP Request

`PUT /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the NetworkPolicy
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` NetworkPolicy |

### Response

Code | Description
--- | ---
200 NetworkPolicy | OK
201 NetworkPolicy | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a NetworkPolicy

### HTTP Request

`DELETE /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the NetworkPolicy
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of NetworkPolicy

### HTTP Request

`DELETE /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified NetworkPolicy

### HTTP Request

`GET /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the NetworkPolicy
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Response

Code | Description
--- | ---
200 NetworkPolicy | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind NetworkPolicy

### HTTP Request

`GET /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 NetworkPolicyList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind NetworkPolicy

### HTTP Request

`GET /apis/networking.k8s.io/v1/networkpolicies`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 NetworkPolicyList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind NetworkPolicy

### HTTP Request

`GET /apis/networking.k8s.io/v1/watch/namespaces/{namespace}/networkpolicies/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the NetworkPolicy
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of NetworkPolicy

### HTTP Request

`GET /apis/networking.k8s.io/v1/watch/namespaces/{namespace}/networkpolicies`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of NetworkPolicy

### HTTP Request

`GET /apis/networking.k8s.io/v1/watch/networkpolicies`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

# DEFINITIONS

This section contains definitions for objects used in the Kubernetes APIs.

## APIGroup v1 meta

Group | Version | Kind
--- | --- | ---
`meta` | `v1` | `APIGroup`

APIGroup contains the name, the supported versions, and the preferred version of a group.

Appears In:

- APIGroupList meta/v1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`name` string | name is the name of the group.
`preferredVersion` GroupVersionForDiscovery | preferredVersion is the version preferred by the API server, which probably is the storage version.
`serverAddressByClientCIDRs` ServerAddressByClientCIDR 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.
`versions` GroupVersionForDiscovery array | versions are the versions supported in this group.

## APIResource v1 meta

Group | Version | Kind
--- | --- | ---
`meta` | `v1` | `APIResource`

APIResource specifies the name of a resource and whether it is namespaced.

Appears In:

- APIResourceList meta/v1

Field | Description
--- | ---
`categories` string array | categories is a list of the grouped resources this resource belongs to (e.g. 'all')
`group` string | group is the preferred group of the resource. Empty implies the group of the containing resource list. For subresources, this may have a different value, for example: Scale".
`kind` string | kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')
`name` string | name is the plural name of the resource.
`namespaced` boolean | namespaced indicates if a resource is namespaced or not.
`shortNames` string array | shortNames is a list of suggested short names of the resource.
`singularName` string | singularName is the singular name of the resource. This allows clients to handle plural and singular opaquely. The singularName is more correct for reporting status on a single item and both singular and plural are allowed from the kubectl CLI interface.
`verbs` string array | verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy)
`version` string | version is the preferred version of the resource. Empty implies the version of the containing resource list For subresources, this may have a different value, for example: v1 (while inside a v1beta1 version of the core resource's group)".

## APIServiceCondition v1 apiregistration

Group | Version | Kind
--- | --- | ---
`apiregistration.k8s.io` | `v1` | `APIServiceCondition`

Other API versions of this object exist: v1beta1
Appears In:

- APIServiceStatus apiregistration/v1

Field | Description
--- | ---
`lastTransitionTime` Time | Last time the condition transitioned from one status to another.
`message` string | Human-readable message indicating details about last transition.
`reason` string | Unique, one-word, CamelCase reason for the condition's last transition.
`status` string | Status is the status of the condition. Can be True, False, Unknown.
`type` string | Type is the type of the condition.

## APIVersions v1 meta

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
--- | ---
`apiVersion` string | 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
`kind` string | 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
`serverAddressByClientCIDRs` ServerAddressByClientCIDR 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.
`versions` string array | versions are the api versions that are available.

## AWSElasticBlockStoreVolumeSource v1 core

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.

Appears In:

- PersistentVolumeSpec core/v1
- Volume core/v1

Field | Description
--- | ---
`fsType` string | Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
`partition` integer | The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
`readOnly` boolean | 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
`volumeID` string | Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

## Affinity v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `Affinity`

Affinity is a group of affinity scheduling rules.

Appears In:

- PodSpec core/v1

Field | Description
--- | ---
`nodeAffinity` NodeAffinity | Describes node affinity scheduling rules for the pod.
`podAffinity` PodAffinity | Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
`podAntiAffinity` PodAntiAffinity | Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

## AggregationRule v1 rbac

Group | Version | Kind
--- | --- | ---
`rbac.authorization.k8s.io` | `v1` | `AggregationRule`

Other API versions of this object exist: v1beta1 v1alpha1

AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole

Appears In:

- ClusterRole rbac/v1

Field | Description
--- | ---
`clusterRoleSelectors` LabelSelector 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

## AllowedFlexVolume v1beta1 extensions

Group | Version | Kind
--- | --- | ---
`extensions` | `v1beta1` | `AllowedFlexVolume`

AllowedFlexVolume represents a single Flexvolume that is allowed to be used.

Appears In:

- PodSecurityPolicySpec extensions/v1beta1

Field | Description
--- | ---
`driver` string | Driver is the name of the Flexvolume driver.

## AllowedHostPath v1beta1 extensions

Group | Version | Kind
--- | --- | ---
`extensions` | `v1beta1` | `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.

Appears In:

- PodSecurityPolicySpec extensions/v1beta1

Field | Description
--- | ---
`pathPrefix` string | is the path prefix that the host volume must match. It does not support `*`. Trailing slashes are trimmed when validating the path prefix with a host path. Examples: `/foo` would allow `/foo`, `/foo/` and `/foo/bar` `/foo` would not allow `/food` or `/etc/foo`

## AttachedVolume v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `AttachedVolume`

AttachedVolume describes a volume attached to a node

Appears In:

- NodeStatus core/v1

Field | Description
--- | ---
`devicePath` string | DevicePath represents the device path where the volume should be available
`name` string | Name of the attached volume

## AzureDiskVolumeSource v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `AzureDiskVolumeSource`

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

Appears In:

- PersistentVolumeSpec core/v1
- Volume core/v1

Field | Description
--- | ---
`cachingMode` string | Host Caching mode: None, Read Only, Read Write.
`diskName` string | The Name of the data disk in the blob storage
`diskURI` string | The URI the data disk in the blob storage
`fsType` string | Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
`kind` string | Expected values Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared
`readOnly` boolean | Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

## AzureFilePersistentVolumeSource v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `AzureFilePersistentVolumeSource`

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

Appears In:

- PersistentVolumeSpec core/v1

Field | Description
--- | ---
`readOnly` boolean | Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
`secretName` string | the name of secret that contains Azure Storage Account Name and Key
`secretNamespace` string | the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod
`shareName` string | Share Name

## AzureFileVolumeSource v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `AzureFileVolumeSource`

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

Appears In:

- Volume core/v1

Field | Description
--- | ---
`readOnly` boolean | Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
`secretName` string | the name of secret that contains Azure Storage Account Name and Key
`shareName` string | Share Name

## CSIPersistentVolumeSource v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `CSIPersistentVolumeSource`

Represents storage that is managed by an external CSI volume driver (Beta feature)

Appears In:

- PersistentVolumeSpec core/v1

Field | Description
--- | ---
`controllerPublishSecretRef` SecretReference | 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.
`driver` string | Driver is the name of the driver to use for this volume. Required.
`fsType` string | Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
`nodePublishSecretRef` SecretReference | NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
`nodeStageSecretRef` SecretReference | NodeStageSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeStageVolume and NodeStageVolume and NodeUnstageVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
`readOnly` boolean | Optional: The value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write).
`volumeAttributes` object | Attributes of the volume to publish.
`volumeHandle` string | VolumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required.

## Capabilities v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `Capabilities`

Adds and removes POSIX capabilities from running containers.

Appears In:

- SecurityContext core/v1

Field | Description
--- | ---
`add` string array | Added capabilities
`drop` string array | Removed capabilities

## CephFSPersistentVolumeSource v1 core

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.

Appears In:

- PersistentVolumeSpec core/v1

Field | Description
--- | ---
`monitors` string 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
`path` string | Optional: Used as the mounted root, rather than the full Ceph tree, default is /
`readOnly` boolean | 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
`secretFile` string | 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
`secretRef` SecretReference | 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
`user` string | 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

## CephFSVolumeSource v1 core

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.

Appears In:

- Volume core/v1

Field | Description
--- | ---
`monitors` string 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
`path` string | Optional: Used as the mounted root, rather than the full Ceph tree, default is /
`readOnly` boolean | 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
`secretFile` string | 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
`secretRef` LocalObjectReference | 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
`user` string | 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

## CertificateSigningRequestCondition v1beta1 certificates

Group | Version | Kind
--- | --- | ---
`certificates.k8s.io` | `v1beta1` | `CertificateSigningRequestCondition`

Appears In:

- CertificateSigningRequestStatus certificates/v1beta1

Field | Description
--- | ---
`lastUpdateTime` Time | timestamp for the last update to this condition
`message` string | human readable message with details about the request state
`reason` string | brief reason for the request state
`type` string | request approval state, currently Approved or Denied.

## CinderVolumeSource v1 core

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.

Appears In:

- PersistentVolumeSpec core/v1
- Volume core/v1

Field | Description
--- | ---
`fsType` string | 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
`readOnly` boolean | 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
`volumeID` string | volume id used to identify the volume in cinder More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

## ClientIPConfig v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `ClientIPConfig`

ClientIPConfig represents the configurations of Client IP based session affinity.

Appears In:

- SessionAffinityConfig core/v1

Field | Description
--- | ---
`timeoutSeconds` integer | timeoutSeconds specifies the seconds of ClientIP type session sticky time. The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP". Default value is 10800(for 3 hours).

## ComponentCondition v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `ComponentCondition`

Information about the condition of a component.

Appears In:

- ComponentStatus core/v1

Field | Description
--- | ---
`error` string | Condition error code for a component. For example, a health check error code.
`message` string | Message about the condition for a component. For example, information about a health check.
`status` string | Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown".
`type` string | Type of condition for a component. Valid value: "Healthy"

## ConfigMapEnvSource v1 core

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.

Appears In:

- EnvFromSource core/v1

Field | Description
--- | ---
`name` string | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
`optional` boolean | Specify whether the ConfigMap must be defined

## ConfigMapKeySelector v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `ConfigMapKeySelector`

Selects a key from a ConfigMap.

Appears In:

- EnvVarSource core/v1

Field | Description
--- | ---
`key` string | The key to select.
`name` string | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
`optional` boolean | Specify whether the ConfigMap or it's key must be defined

## ConfigMapProjection v1 core

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.

Appears In:

- VolumeProjection core/v1

Field | Description
--- | ---
`items` KeyToPath 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 '..'.
`name` string | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
`optional` boolean | Specify whether the ConfigMap or it's keys must be defined

## ConfigMapVolumeSource v1 core

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.

Appears In:

- Volume core/v1

Field | Description
--- | ---
`defaultMode` integer | Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
`items` KeyToPath 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 '..'.
`name` string | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
`optional` boolean | Specify whether the ConfigMap or it's keys must be defined

## ContainerImage v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `ContainerImage`

Describe a container image

Appears In:

- NodeStatus core/v1

Field | Description
--- | ---
`names` string 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"]
`sizeBytes` integer | The size of the image in bytes.

## ContainerPort v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `ContainerPort`

ContainerPort represents a network port in a single container.

Appears In:

- Container core/v1

Field | Description
--- | ---
`containerPort` integer | Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
`hostIP` string | What host IP to bind the external port to.
`hostPort` integer | Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.
`name` string | If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
`protocol` string | Protocol for port. Must be UDP or TCP. Defaults to "TCP".

## ContainerState v1 core

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.

Appears In:

- ContainerStatus core/v1

Field | Description
--- | ---
`running` ContainerStateRunning | Details about a running container
`terminated` ContainerStateTerminated | Details about a terminated container
`waiting` ContainerStateWaiting | Details about a waiting container

## ContainerStateRunning v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `ContainerStateRunning`

ContainerStateRunning is a running state of a container.

Appears In:

- ContainerState core/v1

Field | Description
--- | ---
`startedAt` Time | Time at which the container was last (re-)started

## ContainerStateTerminated v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `ContainerStateTerminated`

ContainerStateTerminated is a terminated state of a container.

Appears In:

- ContainerState core/v1

Field | Description
--- | ---
`containerID` string | Container's ID in the format 'docker://<container_id>'
`exitCode` integer | Exit status from the last termination of the container
`finishedAt` Time | Time at which the container last terminated
`message` string | Message regarding the last termination of the container
`reason` string | (brief) reason from the last termination of the container
`signal` integer | Signal from the last termination of the container
`startedAt` Time | Time at which previous execution of the container started

## ContainerStateWaiting v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `ContainerStateWaiting`

ContainerStateWaiting is a waiting state of a container.

Appears In:

- ContainerState core/v1

Field | Description
--- | ---
`message` string | Message regarding why the container is not yet running.
`reason` string | (brief) reason the container is not yet running.

## CrossVersionObjectReference v1 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v1` | `CrossVersionObjectReference`

Other API versions of this object exist: v2beta1

CrossVersionObjectReference contains enough information to let you identify the referred resource.

Appears In:

- HorizontalPodAutoscalerSpec autoscaling/v1

Field | Description
--- | ---
`apiVersion` string | API version of the referent
`kind` string | Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds&#34;
`name` string | Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names

## CustomResourceDefinitionCondition v1beta1 apiextensions

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1beta1` | `CustomResourceDefinitionCondition`

CustomResourceDefinitionCondition contains details for the current condition of this pod.

Appears In:

- CustomResourceDefinitionStatus apiextensions/v1beta1

Field | Description
--- | ---
`lastTransitionTime` Time | Last time the condition transitioned from one status to another.
`message` string | Human-readable message indicating details about last transition.
`reason` string | Unique, one-word, CamelCase reason for the condition's last transition.
`status` string | Status is the status of the condition. Can be True, False, Unknown.
`type` string | Type is the type of the condition.

## CustomResourceDefinitionNames v1beta1 apiextensions

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1beta1` | `CustomResourceDefinitionNames`

CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition

Appears In:

- CustomResourceDefinitionSpec apiextensions/v1beta1
- CustomResourceDefinitionStatus apiextensions/v1beta1

Field | Description
--- | ---
`categories` string array | Categories is a list of grouped resources custom resources belong to (e.g. 'all')
`kind` string | Kind is the serialized kind of the resource. It is normally CamelCase and singular.
`listKind` string | ListKind is the serialized kind of the list for this resource. Defaults to <kind>List.
`plural` string | Plural is the plural name of the resource to serve. It must match the name of the CustomResourceDefinition-registration too: plural.group and it must be all lowercase.
`shortNames` string array | ShortNames are short names for the resource. It must be all lowercase.
`singular` string | Singular is the singular name of the resource. It must be all lowercase Defaults to lowercased <kind>

## CustomResourceSubresourceScale v1beta1 apiextensions

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1beta1` | `CustomResourceSubresourceScale`

CustomResourceSubresourceScale defines how to serve the scale subresource for CustomResources.

Appears In:

- CustomResourceSubresources apiextensions/v1beta1

Field | Description
--- | ---
`labelSelectorPath` string | LabelSelectorPath defines the JSON path inside of a CustomResource that corresponds to Scale.Status.Selector. Only JSON paths without the array notation are allowed. Must be a JSON Path under .status. Must be set to work with HPA. If there is no value under the given path in the CustomResource, the status label selector value in the /scale subresource will default to the empty string.
`specReplicasPath` string | SpecReplicasPath defines the JSON path inside of a CustomResource that corresponds to Scale.Spec.Replicas. Only JSON paths without the array notation are allowed. Must be a JSON Path under .spec. If there is no value under the given path in the CustomResource, the /scale subresource will return an error on GET.
`statusReplicasPath` string | StatusReplicasPath defines the JSON path inside of a CustomResource that corresponds to Scale.Status.Replicas. Only JSON paths without the array notation are allowed. Must be a JSON Path under .status. If there is no value under the given path in the CustomResource, the status replica value in the /scale subresource will default to 0.

## CustomResourceSubresourceStatus v1beta1 apiextensions

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

Appears In:

- CustomResourceSubresources apiextensions/v1beta1

Field | Description
--- | ---

## CustomResourceSubresources v1beta1 apiextensions

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1beta1` | `CustomResourceSubresources`

CustomResourceSubresources defines the status and scale subresources for CustomResources.

Appears In:

- CustomResourceDefinitionSpec apiextensions/v1beta1

Field | Description
--- | ---
`scale` CustomResourceSubresourceScale | Scale denotes the scale subresource for CustomResources
`status` CustomResourceSubresourceStatus | Status denotes the status subresource for CustomResources

## CustomResourceValidation v1beta1 apiextensions

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1beta1` | `CustomResourceValidation`

CustomResourceValidation is a list of validation methods for CustomResources.

Appears In:

- CustomResourceDefinitionSpec apiextensions/v1beta1

Field | Description
--- | ---
`openAPIV3Schema` JSONSchemaProps | OpenAPIV3Schema is the OpenAPI v3 schema to be validated against.

## DaemonEndpoint v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `DaemonEndpoint`

DaemonEndpoint contains information about a single Daemon endpoint.

Appears In:

- NodeDaemonEndpoints core/v1

Field | Description
--- | ---
`Port` integer | Port number of the given endpoint.

## DaemonSetCondition v1 apps

Group | Version | Kind
--- | --- | ---
`apps` | `v1` | `DaemonSetCondition`

Other API versions of this object exist: v1beta2 v1beta1

DaemonSetCondition describes the state of a DaemonSet at a certain point.

Appears In:

- DaemonSetStatus apps/v1

Field | Description
--- | ---
`lastTransitionTime` Time | Last time the condition transitioned from one status to another.
`message` string | A human readable message indicating details about the transition.
`reason` string | The reason for the condition's last transition.
`status` string | Status of the condition, one of True, False, Unknown.
`type` string | Type of DaemonSet condition.

## DaemonSetUpdateStrategy v1 apps

Group | Version | Kind
--- | --- | ---
`apps` | `v1` | `DaemonSetUpdateStrategy`

Other API versions of this object exist: v1beta2 v1beta1

DaemonSetUpdateStrategy is a struct used to control the update strategy for a DaemonSet.

Appears In:

- DaemonSetSpec apps/v1

Field | Description
--- | ---
`rollingUpdate` RollingUpdateDaemonSet | Rolling update config params. Present only if type = "RollingUpdate".
`type` string | Type of daemon set update. Can be "RollingUpdate" or "OnDelete". Default is RollingUpdate.

## DeleteOptions v1 meta

Group | Version | Kind
--- | --- | ---
`meta` | `v1` | `DeleteOptions`

DeleteOptions may be provided when deleting an API object.

Appears In:

- Eviction policy/v1beta1

Field | Description
--- | ---
`apiVersion` string | 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
`gracePeriodSeconds` integer | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`kind` string | 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
`orphanDependents` boolean | 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.
`preconditions` Preconditions | Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.
`propagationPolicy` string | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

## DeploymentCondition v1 apps

Group | Version | Kind
--- | --- | ---
`apps` | `v1` | `DeploymentCondition`

Other API versions of this object exist: v1beta2 v1beta1 v1beta1

DeploymentCondition describes the state of a deployment at a certain point.

Appears In:

- DeploymentStatus apps/v1

Field | Description
--- | ---
`lastTransitionTime` Time | Last time the condition transitioned from one status to another.
`lastUpdateTime` Time | The last time this condition was updated.
`message` string | A human readable message indicating details about the transition.
`reason` string | The reason for the condition's last transition.
`status` string | Status of the condition, one of True, False, Unknown.
`type` string | Type of deployment condition.

## DownwardAPIProjection v1 core

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.

Appears In:

- VolumeProjection core/v1

Field | Description
--- | ---
`items` DownwardAPIVolumeFile array | Items is a list of DownwardAPIVolume file

## DownwardAPIVolumeFile v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `DownwardAPIVolumeFile`

DownwardAPIVolumeFile represents information to create the file containing the pod field

Appears In:

- DownwardAPIProjection core/v1
- DownwardAPIVolumeSource core/v1

Field | Description
--- | ---
`fieldRef` ObjectFieldSelector | Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
`mode` integer | 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.
`path` string | 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 '..'
`resourceFieldRef` ResourceFieldSelector | Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

## DownwardAPIVolumeSource v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `DownwardAPIVolumeSource`

DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.

Appears In:

- Volume core/v1

Field | Description
--- | ---
`defaultMode` integer | Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
`items` DownwardAPIVolumeFile array | Items is a list of downward API volume file

## EmptyDirVolumeSource v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `EmptyDirVolumeSource`

Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.

Appears In:

- Volume core/v1

Field | Description
--- | ---
`medium` string | 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
`sizeLimit` Quantity | 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

## EndpointAddress v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `EndpointAddress`

EndpointAddress is a tuple that describes single IP address.

Appears In:

- EndpointSubset core/v1

Field | Description
--- | ---
`hostname` string | The Hostname of this endpoint
`ip` string | 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.
`nodeName` string | Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node.
`targetRef` ObjectReference | Reference to object providing the endpoint.

## EndpointPort v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `EndpointPort`

EndpointPort is a tuple that describes a single port.

Appears In:

- EndpointSubset core/v1

Field | Description
--- | ---
`name` string | The name of this port (corresponds to ServicePort.Name). Must be a DNS_LABEL. Optional only if one port is defined.
`port` integer | The port number of the endpoint.
`protocol` string | The IP protocol for this port. Must be UDP or TCP. Default is TCP.

## EndpointSubset v1 core

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 ]

Appears In:

- Endpoints core/v1

Field | Description
--- | ---
`addresses` EndpointAddress 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.
`notReadyAddresses` EndpointAddress 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.
`ports` EndpointPort array | Port numbers available on the related IP addresses.

## EnvFromSource v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `EnvFromSource`

EnvFromSource represents the source of a set of ConfigMaps

Appears In:

- Container core/v1
- PodPresetSpec settings/v1alpha1

Field | Description
--- | ---
`configMapRef` ConfigMapEnvSource | The ConfigMap to select from
`prefix` string | An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
`secretRef` SecretEnvSource | The Secret to select from

## EnvVar v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `EnvVar`

EnvVar represents an environment variable present in a Container.

Appears In:

- Container core/v1
- PodPresetSpec settings/v1alpha1

Field | Description
--- | ---
`name` string | Name of the environment variable. Must be a C_IDENTIFIER.
`value` string | 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 "".
`valueFrom` EnvVarSource | Source for the environment variable's value. Cannot be used if value is not empty.

## EnvVarSource v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `EnvVarSource`

EnvVarSource represents a source for the value of an EnvVar.

Appears In:

- EnvVar core/v1

Field | Description
--- | ---
`configMapKeyRef` ConfigMapKeySelector | Selects a key of a ConfigMap.
`fieldRef` ObjectFieldSelector | Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP.
`resourceFieldRef` ResourceFieldSelector | 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.
`secretKeyRef` SecretKeySelector | Selects a key of a secret in the pod's namespace

## EventSeries v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `EventSeries`

Other API versions of this object exist: v1beta1

EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time.

Appears In:

- Event core/v1

Field | Description
--- | ---
`count` integer | Number of occurrences in this series up to the last heartbeat time
`lastObservedTime` MicroTime | Time of the last occurrence observed
`state` string | State of this Series: Ongoing or Finished

## EventSource v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `EventSource`

EventSource contains information for an event.

Appears In:

- Event core/v1
- Event events/v1beta1

Field | Description
--- | ---
`component` string | Component from which the event is generated.
`host` string | Node name on which the event is generated.

## Eviction v1beta1 policy

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
--- | ---
`apiVersion` string | 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
`deleteOptions` DeleteOptions | DeleteOptions may be provided
`kind` string | 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
`metadata` ObjectMeta | ObjectMeta describes the pod that is being evicted.

## ExecAction v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `ExecAction`

ExecAction describes a "run in container" action.

Appears In:

- Handler core/v1
- Probe core/v1

Field | Description
--- | ---
`command` string 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.

## ExternalDocumentation v1beta1 apiextensions

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1beta1` | `ExternalDocumentation`

ExternalDocumentation allows referencing an external resource for extended documentation.

Appears In:

- JSONSchemaProps apiextensions/v1beta1

Field | Description
--- | ---
`description` string |
`url` string |

## ExternalMetricSource v2beta1 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta1` | `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). Exactly one "target" type should be set.

Appears In:

- MetricSpec autoscaling/v2beta1

Field | Description
--- | ---
`metricName` string | metricName is the name of the metric in question.
`metricSelector` LabelSelector | metricSelector is used to identify a specific time series within a given metric.
`targetAverageValue` Quantity | targetAverageValue is the target per-pod value of global metric (as a quantity). Mutually exclusive with TargetValue.
`targetValue` Quantity | targetValue is the target value of the metric (as a quantity). Mutually exclusive with TargetAverageValue.

## ExternalMetricStatus v2beta1 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta1` | `ExternalMetricStatus`

ExternalMetricStatus indicates the current value of a global metric not associated with any Kubernetes object.

Appears In:

- MetricStatus autoscaling/v2beta1

Field | Description
--- | ---
`currentAverageValue` Quantity | currentAverageValue is the current value of metric averaged over autoscaled pods.
`currentValue` Quantity | currentValue is the current value of the metric (as a quantity)
`metricName` string | metricName is the name of a metric used for autoscaling in metric system.
`metricSelector` LabelSelector | metricSelector is used to identify a specific time series within a given metric.

## FCVolumeSource v1 core

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.

Appears In:

- PersistentVolumeSpec core/v1
- Volume core/v1

Field | Description
--- | ---
`fsType` string | Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
`lun` integer | Optional: FC target lun number
`readOnly` boolean | Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
`targetWWNs` string array | Optional: FC target worldwide names (WWNs)
`wwids` string array | Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.

## FSGroupStrategyOptions v1beta1 extensions

Group | Version | Kind
--- | --- | ---
`extensions` | `v1beta1` | `FSGroupStrategyOptions`

FSGroupStrategyOptions defines the strategy type and options used to create the strategy.

Appears In:

- PodSecurityPolicySpec extensions/v1beta1

Field | Description
--- | ---
`ranges` IDRange 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.
`rule` string | Rule is the strategy that will dictate what FSGroup is used in the SecurityContext.

## FlexPersistentVolumeSource v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `FlexPersistentVolumeSource`

FlexPersistentVolumeSource represents a generic persistent volume resource that is provisioned/attached using an exec based plugin.

Appears In:

- PersistentVolumeSpec core/v1

Field | Description
--- | ---
`driver` string | Driver is the name of the driver to use for this volume.
`fsType` string | 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.
`options` object | Optional: Extra command options if any.
`readOnly` boolean | Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
`secretRef` SecretReference | 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.

## FlexVolumeSource v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `FlexVolumeSource`

FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

Appears In:

- Volume core/v1

Field | Description
--- | ---
`driver` string | Driver is the name of the driver to use for this volume.
`fsType` string | 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.
`options` object | Optional: Extra command options if any.
`readOnly` boolean | Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
`secretRef` LocalObjectReference | 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.

## FlockerVolumeSource v1 core

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.

Appears In:

- PersistentVolumeSpec core/v1
- Volume core/v1

Field | Description
--- | ---
`datasetName` string | Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
`datasetUUID` string | UUID of the dataset. This is unique identifier of a Flocker dataset

## GCEPersistentDiskVolumeSource v1 core

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.

Appears In:

- PersistentVolumeSpec core/v1
- Volume core/v1

Field | Description
--- | ---
`fsType` string | Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
`partition` integer | The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
`pdName` string | 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
`readOnly` boolean | ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

## GitRepoVolumeSource v1 core

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.

Appears In:

- Volume core/v1

Field | Description
--- | ---
`directory` string | 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.
`repository` string | Repository URL
`revision` string | Commit hash for the specified revision.

## GlusterfsVolumeSource v1 core

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.

Appears In:

- PersistentVolumeSpec core/v1
- Volume core/v1

Field | Description
--- | ---
`endpoints` string | EndpointsName is the endpoint name that details Glusterfs topology. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod
`path` string | Path is the Glusterfs volume path. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod
`readOnly` boolean | 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

## GroupVersionForDiscovery v1 meta

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.

Appears In:

- APIGroup meta/v1

Field | Description
--- | ---
`groupVersion` string | groupVersion specifies the API group and version in the form "group/version"
`version` string | version specifies the version in the form of "version". This is to save the clients the trouble of splitting the GroupVersion.

## HTTPGetAction v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `HTTPGetAction`

HTTPGetAction describes an action based on HTTP Get requests.

Appears In:

- Handler core/v1
- Probe core/v1

Field | Description
--- | ---
`host` string | Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
`httpHeaders` HTTPHeader array | Custom headers to set in the request. HTTP allows repeated headers.
`path` string | 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.
`scheme` string | Scheme to use for connecting to the host. Defaults to HTTP.

## HTTPHeader v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `HTTPHeader`

HTTPHeader describes a custom header to be used in HTTP probes

Appears In:

- HTTPGetAction core/v1

Field | Description
--- | ---
`name` string | The header field name
`value` string | The header field value

## HTTPIngressPath v1beta1 extensions

Group | Version | Kind
--- | --- | ---
`extensions` | `v1beta1` | `HTTPIngressPath`

HTTPIngressPath associates a path regex with a backend. Incoming urls matching the path are forwarded to the backend.

Appears In:

- HTTPIngressRuleValue extensions/v1beta1

Field | Description
--- | ---
`backend` IngressBackend | Backend defines the referenced service endpoint to which the traffic will be forwarded to.
`path` string | 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.

## HTTPIngressRuleValue v1beta1 extensions

Group | Version | Kind
--- | --- | ---
`extensions` | `v1beta1` | `HTTPIngressRuleValue`

HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http://<host>/<path>?<searchpart&gt; -> 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 '#'.

Appears In:

- IngressRule extensions/v1beta1

Field | Description
--- | ---
`paths` HTTPIngressPath array | A collection of paths that map requests to backends.

## Handler v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `Handler`

Handler defines a specific action that should be taken

Appears In:

- Lifecycle core/v1

Field | Description
--- | ---
`exec` ExecAction | One and only one of the following should be specified. Exec specifies the action to take.
`httpGet` HTTPGetAction | HTTPGet specifies the http request to perform.
`tcpSocket` TCPSocketAction | TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

## HorizontalPodAutoscalerCondition v2beta1 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta1` | `HorizontalPodAutoscalerCondition`

HorizontalPodAutoscalerCondition describes the state of a HorizontalPodAutoscaler at a certain point.

Appears In:

- HorizontalPodAutoscalerStatus autoscaling/v2beta1

Field | Description
--- | ---
`lastTransitionTime` Time | lastTransitionTime is the last time the condition transitioned from one status to another
`message` string | message is a human-readable explanation containing details about the transition
`reason` string | reason is the reason for the condition's last transition.
`status` string | status is the status of the condition (True, False, Unknown)
`type` string | type describes the current condition

## HostAlias v1 core

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.

Appears In:

- PodSpec core/v1

Field | Description
--- | ---
`hostnames` string array | Hostnames for the above IP address.
`ip` string | IP address of the host file entry.

## HostPathVolumeSource v1 core

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.

Appears In:

- PersistentVolumeSpec core/v1
- Volume core/v1

Field | Description
--- | ---
`path` string | 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
`type` string | Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

## HostPortRange v1beta1 extensions

Group | Version | Kind
--- | --- | ---
`extensions` | `v1beta1` | `HostPortRange`

Host Port Range 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.

Appears In:

- PodSecurityPolicySpec extensions/v1beta1

Field | Description
--- | ---
`max` integer | max is the end of the range, inclusive.
`min` integer | min is the start of the range, inclusive.

## IDRange v1beta1 extensions

Group | Version | Kind
--- | --- | ---
`extensions` | `v1beta1` | `IDRange`

ID Range provides a min/max of an allowed range of IDs.

Appears In:

- FSGroupStrategyOptions extensions/v1beta1
- RunAsUserStrategyOptions extensions/v1beta1
- SupplementalGroupsStrategyOptions extensions/v1beta1

Field | Description
--- | ---
`max` integer | Max is the end of the range, inclusive.
`min` integer | Min is the start of the range, inclusive.

## IPBlock v1 networking

Group | Version | Kind
--- | --- | ---
`networking.k8s.io` | `v1` | `IPBlock`

Other API versions of this object exist: v1beta1

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.

Appears In:

- NetworkPolicyPeer networking/v1

Field | Description
--- | ---
`cidr` string | CIDR is a string representing the IP Block Valid examples are "192.168.1.1/24"
`except` string array | Except is a slice of CIDRs that should not be included within an IP Block Valid examples are "192.168.1.1/24" Except values will be rejected if they are outside the CIDR range

## ISCSIPersistentVolumeSource v1 core

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.

Appears In:

- PersistentVolumeSpec core/v1

Field | Description
--- | ---
`chapAuthDiscovery` boolean | whether support iSCSI Discovery CHAP authentication
`chapAuthSession` boolean | whether support iSCSI Session CHAP authentication
`fsType` string | Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi
`initiatorName` string | Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.
`iqn` string | Target iSCSI Qualified Name.
`iscsiInterface` string | iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
`lun` integer | iSCSI Target Lun number.
`portals` string 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).
`readOnly` boolean | ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
`secretRef` SecretReference | CHAP Secret for iSCSI target and initiator authentication
`targetPortal` string | 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).

## ISCSIVolumeSource v1 core

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.

Appears In:

- Volume core/v1

Field | Description
--- | ---
`chapAuthDiscovery` boolean | whether support iSCSI Discovery CHAP authentication
`chapAuthSession` boolean | whether support iSCSI Session CHAP authentication
`fsType` string | Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi
`initiatorName` string | Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.
`iqn` string | Target iSCSI Qualified Name.
`iscsiInterface` string | iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
`lun` integer | iSCSI Target Lun number.
`portals` string 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).
`readOnly` boolean | ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
`secretRef` LocalObjectReference | CHAP Secret for iSCSI target and initiator authentication
`targetPortal` string | 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).

## IngressBackend v1beta1 extensions

Group | Version | Kind
--- | --- | ---
`extensions` | `v1beta1` | `IngressBackend`

IngressBackend describes all endpoints for a given service and port.

Appears In:

- HTTPIngressPath extensions/v1beta1
- IngressSpec extensions/v1beta1

Field | Description
--- | ---
`serviceName` string | Specifies the name of the referenced service.
`servicePort` | Specifies the port of the referenced service.

## IngressRule v1beta1 extensions

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.

Appears In:

- IngressSpec extensions/v1beta1

Field | Description
--- | ---
`host` string | 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.
`http` HTTPIngressRuleValue |

## IngressTLS v1beta1 extensions

Group | Version | Kind
--- | --- | ---
`extensions` | `v1beta1` | `IngressTLS`

IngressTLS describes the transport layer security associated with an Ingress.

Appears In:

- IngressSpec extensions/v1beta1

Field | Description
--- | ---
`hosts` string 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.
`secretName` string | 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.

## Initializer v1 meta

Group | Version | Kind
--- | --- | ---
`meta` | `v1` | `Initializer`

Other API versions of this object exist: v1alpha1

Initializer is information about an initializer that has not yet completed.

Appears In:

- Initializers meta/v1

Field | Description
--- | ---
`name` string | name of the process that is responsible for initializing this object.

## Initializers v1 meta

Group | Version | Kind
--- | --- | ---
`meta` | `v1` | `Initializers`

Initializers tracks the progress of initialization.

Appears In:

- ObjectMeta meta/v1

Field | Description
--- | ---
`pending` Initializer array patch type: 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.
`result` Status | 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.

## JSON v1beta1 apiextensions

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.

Appears In:

- JSONSchemaProps apiextensions/v1beta1

Field | Description
--- | ---
`Raw` string |

## JSONSchemaProps v1beta1 apiextensions

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1beta1` | `JSONSchemaProps`

JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/).

Appears In:

- CustomResourceValidation apiextensions/v1beta1
- JSONSchemaProps apiextensions/v1beta1
- JSONSchemaPropsOrArray apiextensions/v1beta1
- JSONSchemaPropsOrBool apiextensions/v1beta1

Field | Description
--- | ---
`$ref` string |
`$schema` string |
`additionalItems` JSONSchemaPropsOrBool |
`additionalProperties` JSONSchemaPropsOrBool |
`allOf` JSONSchemaProps array |
`anyOf` JSONSchemaProps array |
`default` JSON |
`definitions` object |
`dependencies` object |
`description` string |
`enum` JSON array |
`example` JSON |
`exclusiveMaximum` boolean |
`exclusiveMinimum` boolean |
`externalDocs` ExternalDocumentation |
`format` string |
`id` string |
`items` JSONSchemaPropsOrArray |
`maxItems` integer |
`maxLength` integer |
`maxProperties` integer |
`maximum` number |
`minItems` integer |
`minLength` integer |
`minProperties` integer |
`minimum` number |
`multipleOf` number |
`not` JSONSchemaProps |
`oneOf` JSONSchemaProps array |
`pattern` string |
`patternProperties` object |
`properties` object |
`required` string array |
`title` string |
`type` string |
`uniqueItems` boolean |

## JSONSchemaPropsOrArray v1beta1 apiextensions

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.

Appears In:

- JSONSchemaProps apiextensions/v1beta1

Field | Description
--- | ---
`JSONSchemas` JSONSchemaProps array |
`Schema` JSONSchemaProps |

## JSONSchemaPropsOrBool v1beta1 apiextensions

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1beta1` | `JSONSchemaPropsOrBool`

JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. Defaults to true for the boolean property.

Appears In:

- JSONSchemaProps apiextensions/v1beta1

Field | Description
--- | ---
`Allows` boolean |
`Schema` JSONSchemaProps |

## JobCondition v1 batch

Group | Version | Kind
--- | --- | ---
`batch` | `v1` | `JobCondition`

JobCondition describes current state of a job.

Appears In:

- JobStatus batch/v1

Field | Description
--- | ---
`lastProbeTime` Time | Last time the condition was checked.
`lastTransitionTime` Time | Last time the condition transit from one status to another.
`message` string | Human readable message indicating details about last transition.
`reason` string | (brief) reason for the condition's last transition.
`status` string | Status of the condition, one of True, False, Unknown.
`type` string | Type of job condition, Complete or Failed.

## JobTemplateSpec v1beta1 batch

Group | Version | Kind
--- | --- | ---
`batch` | `v1beta1` | `JobTemplateSpec`

Other API versions of this object exist: v2alpha1

JobTemplateSpec describes the data a Job should have when created from a template

Appears In:

- CronJobSpec batch/v1beta1

Field | Description
--- | ---
`metadata` ObjectMeta | Standard object's metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`spec` JobSpec | Specification of the desired behavior of the job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

## KeyToPath v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `KeyToPath`

Maps a string key to a path within a volume.

Appears In:

- ConfigMapProjection core/v1
- ConfigMapVolumeSource core/v1
- SecretProjection core/v1
- SecretVolumeSource core/v1

Field | Description
--- | ---
`key` string | The key to project.
`mode` integer | 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.
`path` string | 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 '..'.

## LabelSelector v1 meta

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.

Appears In:

- AggregationRule rbac/v1
- AggregationRule rbac/v1beta1
- AggregationRule rbac/v1alpha1
- DaemonSetSpec apps/v1
- DaemonSetSpec apps/v1beta2
- DaemonSetSpec extensions/v1beta1
- DeploymentSpec apps/v1
- DeploymentSpec apps/v1beta2
- DeploymentSpec apps/v1beta1
- DeploymentSpec extensions/v1beta1
- ExternalMetricSource autoscaling/v2beta1
- ExternalMetricStatus autoscaling/v2beta1
- JobSpec batch/v1
- NetworkPolicyPeer networking/v1
- NetworkPolicyPeer extensions/v1beta1
- NetworkPolicySpec networking/v1
- NetworkPolicySpec extensions/v1beta1
- PersistentVolumeClaimSpec core/v1
- PodAffinityTerm core/v1
- PodDisruptionBudgetSpec policy/v1beta1
- PodPresetSpec settings/v1alpha1
- ReplicaSetSpec apps/v1
- ReplicaSetSpec apps/v1beta2
- ReplicaSetSpec extensions/v1beta1
- StatefulSetSpec apps/v1
- StatefulSetSpec apps/v1beta2
- StatefulSetSpec apps/v1beta1
- Webhook admissionregistration/v1beta1

Field | Description
--- | ---
`matchExpressions` LabelSelectorRequirement array | matchExpressions is a list of label selector requirements. The requirements are ANDed.
`matchLabels` object | 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.

## LabelSelectorRequirement v1 meta

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.

Appears In:

- LabelSelector meta/v1

Field | Description
--- | ---
`key` string patch type: merge patch merge key: key | key is the label key that the selector applies to.
`operator` string | operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
`values` string 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.

## Lifecycle v1 core

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.

Appears In:

- Container core/v1

Field | Description
--- | ---
`postStart` Handler | 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
`preStop` Handler | 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

## LimitRangeItem v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `LimitRangeItem`

LimitRangeItem defines a min/max usage limit for any resource that matches on kind.

Appears In:

- LimitRangeSpec core/v1

Field | Description
--- | ---
`default` object | Default resource requirement limit value by resource name if resource limit is omitted.
`defaultRequest` object | DefaultRequest is the default resource requirement request value by resource name if resource request is omitted.
`max` object | Max usage constraints on this kind by resource name.
`maxLimitRequestRatio` object | 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.
`min` object | Min usage constraints on this kind by resource name.
`type` string | Type of resource that this limit applies to.

## ListMeta v1 meta

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}.

Appears In:

- APIServiceList apiregistration/v1
- APIServiceList apiregistration/v1beta1
- CertificateSigningRequestList certificates/v1beta1
- ClusterRoleBindingList rbac/v1
- ClusterRoleBindingList rbac/v1beta1
- ClusterRoleBindingList rbac/v1alpha1
- ClusterRoleList rbac/v1
- ClusterRoleList rbac/v1beta1
- ClusterRoleList rbac/v1alpha1
- ComponentStatusList core/v1
- ConfigMapList core/v1
- ControllerRevisionList apps/v1
- ControllerRevisionList apps/v1beta2
- ControllerRevisionList apps/v1beta1
- CronJobList batch/v1beta1
- CronJobList batch/v2alpha1
- CustomResourceDefinitionList apiextensions/v1beta1
- DaemonSetList apps/v1
- DaemonSetList apps/v1beta2
- DaemonSetList extensions/v1beta1
- DeploymentList apps/v1
- DeploymentList apps/v1beta2
- DeploymentList apps/v1beta1
- DeploymentList extensions/v1beta1
- EndpointsList core/v1
- EventList core/v1
- EventList events/v1beta1
- HorizontalPodAutoscalerList autoscaling/v1
- HorizontalPodAutoscalerList autoscaling/v2beta1
- IngressList extensions/v1beta1
- InitializerConfigurationList admissionregistration/v1alpha1
- JobList batch/v1
- LimitRangeList core/v1
- MutatingWebhookConfigurationList admissionregistration/v1beta1
- NamespaceList core/v1
- NetworkPolicyList networking/v1
- NetworkPolicyList extensions/v1beta1
- NodeList core/v1
- PersistentVolumeClaimList core/v1
- PersistentVolumeList core/v1
- PodDisruptionBudgetList policy/v1beta1
- PodList core/v1
- PodPresetList settings/v1alpha1
- PodSecurityPolicyList extensions/v1beta1
- PodSecurityPolicyList policy/v1beta1
- PodTemplateList core/v1
- PriorityClassList scheduling/v1alpha1
- ReplicaSetList apps/v1
- ReplicaSetList apps/v1beta2
- ReplicaSetList extensions/v1beta1
- ReplicationControllerList core/v1
- ResourceQuotaList core/v1
- RoleBindingList rbac/v1
- RoleBindingList rbac/v1beta1
- RoleBindingList rbac/v1alpha1
- RoleList rbac/v1
- RoleList rbac/v1beta1
- RoleList rbac/v1alpha1
- SecretList core/v1
- ServiceAccountList core/v1
- ServiceList core/v1
- StatefulSetList apps/v1
- StatefulSetList apps/v1beta2
- StatefulSetList apps/v1beta1
- Status meta/v1
- StorageClassList storage/v1
- StorageClassList storage/v1beta1
- ValidatingWebhookConfigurationList admissionregistration/v1beta1
- VolumeAttachmentList storage/v1beta1
- VolumeAttachmentList storage/v1alpha1

Field | Description
--- | ---
`continue` string | 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 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.
`resourceVersion` string | 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
`selfLink` string | selfLink is a URL representing this object. Populated by the system. Read-only.

## LoadBalancerIngress v1 core

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.

Appears In:

- LoadBalancerStatus core/v1

Field | Description
--- | ---
`hostname` string | Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers)
`ip` string | IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers)

## LoadBalancerStatus v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `LoadBalancerStatus`

LoadBalancerStatus represents the status of a load-balancer.

Appears In:

- IngressStatus extensions/v1beta1
- ServiceStatus core/v1

Field | Description
--- | ---
`ingress` LoadBalancerIngress array | Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points.

## LocalObjectReference v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `LocalObjectReference`

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

Appears In:

- CephFSVolumeSource core/v1
- FlexVolumeSource core/v1
- ISCSIVolumeSource core/v1
- PodSpec core/v1
- RBDVolumeSource core/v1
- ScaleIOVolumeSource core/v1
- ServiceAccount core/v1
- StorageOSVolumeSource core/v1

Field | Description
--- | ---
`name` string | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

## LocalVolumeSource v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `LocalVolumeSource`

Local represents directly-attached storage with node affinity

Appears In:

- PersistentVolumeSpec core/v1

Field | Description
--- | ---
`path` string | The full path to the volume on the node For alpha, this path must be a directory Once block as a source is supported, then this path can point to a block device

## MetricSpec v2beta1 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta1` | `MetricSpec`

MetricSpec specifies how to scale based on a single metric (only `type` and one other matching field should be set at once).

Appears In:

- HorizontalPodAutoscalerSpec autoscaling/v2beta1

Field | Description
--- | ---
`external` ExternalMetricSource | 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).
`object` ObjectMetricSource | object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).
`pods` PodsMetricSource | 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.
`resource` ResourceMetricSource | 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.
`type` string | 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.

## MetricStatus v2beta1 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta1` | `MetricStatus`

MetricStatus describes the last-read state of a single metric.

Appears In:

- HorizontalPodAutoscalerStatus autoscaling/v2beta1

Field | Description
--- | ---
`external` ExternalMetricStatus | 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).
`object` ObjectMetricStatus | object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).
`pods` PodsMetricStatus | 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.
`resource` ResourceMetricStatus | 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.
`type` string | 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.

## MicroTime v1 meta

Group | Version | Kind
--- | --- | ---
`meta` | `v1` | `MicroTime`

Appears In:

- Event core/v1
- Event events/v1beta1
- EventSeries core/v1
- EventSeries events/v1beta1

Field | Description
--- | ---

## NFSVolumeSource v1 core

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.

Appears In:

- PersistentVolumeSpec core/v1
- Volume core/v1

Field | Description
--- | ---
`path` string | Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
`readOnly` boolean | 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
`server` string | Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

## NetworkPolicyEgressRule v1 networking

Group | Version | Kind
--- | --- | ---
`networking.k8s.io` | `v1` | `NetworkPolicyEgressRule`

Other API versions of this object exist: v1beta1

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

Appears In:

- NetworkPolicySpec networking/v1

Field | Description
--- | ---
`ports` NetworkPolicyPort 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.
`to` NetworkPolicyPeer 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.

## NetworkPolicyIngressRule v1 networking

Group | Version | Kind
--- | --- | ---
`networking.k8s.io` | `v1` | `NetworkPolicyIngressRule`

Other API versions of this object exist: v1beta1

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.

Appears In:

- NetworkPolicySpec networking/v1

Field | Description
--- | ---
`from` NetworkPolicyPeer 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.
`ports` NetworkPolicyPort 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.

## NetworkPolicyPeer v1 networking

Group | Version | Kind
--- | --- | ---
`networking.k8s.io` | `v1` | `NetworkPolicyPeer`

Other API versions of this object exist: v1beta1

NetworkPolicyPeer describes a peer to allow traffic from. Exactly one of its fields must be specified.

Appears In:

- NetworkPolicyEgressRule networking/v1
- NetworkPolicyIngressRule networking/v1

Field | Description
--- | ---
`ipBlock` IPBlock | IPBlock defines policy on a particular IPBlock
`namespaceSelector` LabelSelector | Selects Namespaces using cluster scoped-labels. This matches all pods in all namespaces selected by this label selector. This field follows standard label selector semantics. If present but empty, this selector selects all namespaces.
`podSelector` LabelSelector | This is a label selector which selects Pods in this namespace. This field follows standard label selector semantics. If present but empty, this selector selects all pods in this namespace.

## NetworkPolicyPort v1 networking

Group | Version | Kind
--- | --- | ---
`networking.k8s.io` | `v1` | `NetworkPolicyPort`

Other API versions of this object exist: v1beta1

NetworkPolicyPort describes a port to allow traffic on

Appears In:

- NetworkPolicyEgressRule networking/v1
- NetworkPolicyIngressRule networking/v1

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.
`protocol` string | The protocol (TCP or UDP) which traffic must match. If not specified, this field defaults to TCP.

## NodeAddress v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `NodeAddress`

NodeAddress contains information for the node's address.

Appears In:

- NodeStatus core/v1

Field | Description
--- | ---
`address` string | The node address.
`type` string | Node address type, one of Hostname, ExternalIP or InternalIP.

## NodeAffinity v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `NodeAffinity`

Node affinity is a group of node affinity scheduling rules.

Appears In:

- Affinity core/v1

Field | Description
--- | ---
`preferredDuringSchedulingIgnoredDuringExecution` PreferredSchedulingTerm 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.
`requiredDuringSchedulingIgnoredDuringExecution` NodeSelector | 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.

## NodeCondition v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `NodeCondition`

NodeCondition contains condition information for a node.

Appears In:

- NodeStatus core/v1

Field | Description
--- | ---
`lastHeartbeatTime` Time | Last time we got an update on a given condition.
`lastTransitionTime` Time | Last time the condition transit from one status to another.
`message` string | Human readable message indicating details about last transition.
`reason` string | (brief) reason for the condition's last transition.
`status` string | Status of the condition, one of True, False, Unknown.
`type` string | Type of node condition.

## NodeConfigSource v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `NodeConfigSource`

NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil.

Appears In:

- NodeSpec core/v1

Field | Description
--- | ---
`apiVersion` string | 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
`configMapRef` ObjectReference |
`kind` string | 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

## NodeDaemonEndpoints v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `NodeDaemonEndpoints`

NodeDaemonEndpoints lists ports opened by daemons running on the Node.

Appears In:

- NodeStatus core/v1

Field | Description
--- | ---
`kubeletEndpoint` DaemonEndpoint | Endpoint on which Kubelet is listening.

## NodeSelector v1 core

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.

Appears In:

- NodeAffinity core/v1
- VolumeNodeAffinity core/v1

Field | Description
--- | ---
`nodeSelectorTerms` NodeSelectorTerm array | Required. A list of node selector terms. The terms are ORed.

## NodeSelectorRequirement v1 core

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.

Appears In:

- NodeSelectorTerm core/v1

Field | Description
--- | ---
`key` string | The label key that the selector applies to.
`operator` string | Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
`values` string 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.

## NodeSelectorTerm v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `NodeSelectorTerm`

A null or empty node selector term matches no objects.

Appears In:

- NodeSelector core/v1
- PreferredSchedulingTerm core/v1

Field | Description
--- | ---
`matchExpressions` NodeSelectorRequirement array | Required. A list of node selector requirements. The requirements are ANDed.

## NodeSystemInfo v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `NodeSystemInfo`

NodeSystemInfo is a set of ids/uuids to uniquely identify the node.

Appears In:

- NodeStatus core/v1

Field | Description
--- | ---
`architecture` string | The Architecture reported by the node
`bootID` string | Boot ID reported by the node.
`containerRuntimeVersion` string | ContainerRuntime Version reported by the node through runtime remote API (e.g. docker://1.5.0).
`kernelVersion` string | Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64).
`kubeProxyVersion` string | KubeProxy Version reported by the node.
`kubeletVersion` string | Kubelet Version reported by the node.
`machineID` string | 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
`operatingSystem` string | The Operating System reported by the node
`osImage` string | OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)).
`systemUUID` string | 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

## NonResourceAttributes v1 authorization

Group | Version | Kind
--- | --- | ---
`authorization.k8s.io` | `v1` | `NonResourceAttributes`

Other API versions of this object exist: v1beta1

NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface

Appears In:

- SelfSubjectAccessReviewSpec authorization/v1
- SubjectAccessReviewSpec authorization/v1

Field | Description
--- | ---
`path` string | Path is the URL path of the request
`verb` string | Verb is the standard HTTP verb

## NonResourceRule v1 authorization

Group | Version | Kind
--- | --- | ---
`authorization.k8s.io` | `v1` | `NonResourceRule`

Other API versions of this object exist: v1beta1

NonResourceRule holds information that describes a rule for the non-resource

Appears In:

- SubjectRulesReviewStatus authorization/v1

Field | Description
--- | ---
`nonResourceURLs` string array | NonResourceURLs is a set of partial urls that a user should have access to. s are allowed, but only as the full, final step in the path. "" means all.
`verbs` string array | Verb is a list of kubernetes non-resource API verbs, like: get, post, put, delete, patch, head, options. "*" means all.

## ObjectFieldSelector v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `ObjectFieldSelector`

ObjectFieldSelector selects an APIVersioned field of an object.

Appears In:

- DownwardAPIVolumeFile core/v1
- EnvVarSource core/v1

Field | Description
--- | ---
`apiVersion` string | Version of the schema the FieldPath is written in terms of, defaults to "v1".
`fieldPath` string | Path of the field to select in the specified API version.

## ObjectMeta v1 meta

Group | Version | Kind
--- | --- | ---
`meta` | `v1` | `ObjectMeta`

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

Appears In:

- APIService apiregistration/v1
- APIService apiregistration/v1beta1
- Binding core/v1
- CertificateSigningRequest certificates/v1beta1
- ClusterRole rbac/v1
- ClusterRole rbac/v1beta1
- ClusterRole rbac/v1alpha1
- ClusterRoleBinding rbac/v1
- ClusterRoleBinding rbac/v1beta1
- ClusterRoleBinding rbac/v1alpha1
- ComponentStatus core/v1
- ConfigMap core/v1
- ControllerRevision apps/v1
- ControllerRevision apps/v1beta2
- ControllerRevision apps/v1beta1
- CronJob batch/v1beta1
- CronJob batch/v2alpha1
- CustomResourceDefinition apiextensions/v1beta1
- DaemonSet apps/v1
- DaemonSet apps/v1beta2
- DaemonSet extensions/v1beta1
- Deployment apps/v1
- Deployment apps/v1beta2
- Deployment apps/v1beta1
- Deployment extensions/v1beta1
- Endpoints core/v1
- Event core/v1
- Event events/v1beta1
- Eviction policy/v1beta1
- HorizontalPodAutoscaler autoscaling/v1
- HorizontalPodAutoscaler autoscaling/v2beta1
- Ingress extensions/v1beta1
- InitializerConfiguration admissionregistration/v1alpha1
- Job batch/v1
- JobTemplateSpec batch/v1beta1
- JobTemplateSpec batch/v2alpha1
- LimitRange core/v1
- LocalSubjectAccessReview authorization/v1
- LocalSubjectAccessReview authorization/v1beta1
- MutatingWebhookConfiguration admissionregistration/v1beta1
- Namespace core/v1
- NetworkPolicy networking/v1
- NetworkPolicy extensions/v1beta1
- Node core/v1
- PersistentVolume core/v1
- PersistentVolumeClaim core/v1
- Pod core/v1
- PodDisruptionBudget policy/v1beta1
- PodPreset settings/v1alpha1
- PodSecurityPolicy extensions/v1beta1
- PodSecurityPolicy policy/v1beta1
- PodTemplate core/v1
- PodTemplateSpec core/v1
- PriorityClass scheduling/v1alpha1
- ReplicaSet apps/v1
- ReplicaSet apps/v1beta2
- ReplicaSet extensions/v1beta1
- ReplicationController core/v1
- ResourceQuota core/v1
- Role rbac/v1
- Role rbac/v1beta1
- Role rbac/v1alpha1
- RoleBinding rbac/v1
- RoleBinding rbac/v1beta1
- RoleBinding rbac/v1alpha1
- Scale autoscaling/v1
- Scale apps/v1beta2
- Scale apps/v1beta1
- Scale extensions/v1beta1
- Secret core/v1
- SelfSubjectAccessReview authorization/v1
- SelfSubjectAccessReview authorization/v1beta1
- SelfSubjectRulesReview authorization/v1
- SelfSubjectRulesReview authorization/v1beta1
- Service core/v1
- ServiceAccount core/v1
- StatefulSet apps/v1
- StatefulSet apps/v1beta2
- StatefulSet apps/v1beta1
- StorageClass storage/v1
- StorageClass storage/v1beta1
- SubjectAccessReview authorization/v1
- SubjectAccessReview authorization/v1beta1
- TokenReview authentication/v1
- TokenReview authentication/v1beta1
- ValidatingWebhookConfiguration admissionregistration/v1beta1
- VolumeAttachment storage/v1beta1
- VolumeAttachment storage/v1alpha1

Field | Description
--- | ---
`annotations` object | 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
`clusterName` string | 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.
`creationTimestamp` Time | 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
`deletionGracePeriodSeconds` integer | 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.
`deletionTimestamp` Time | 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
`finalizers` string array patch type: 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.
`generateName` string | 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
`generation` integer | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
`initializers` Initializers | 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.
`labels` object | 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
`name` string | 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
`namespace` string | 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
`ownerReferences` OwnerReference array patch type: 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.
`resourceVersion` string | 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
`selfLink` string | SelfLink is a URL representing this object. Populated by the system. Read-only.
`uid` string | 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

## ObjectMetricSource v2beta1 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta1` | `ObjectMetricSource`

ObjectMetricSource indicates how to scale on a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).

Appears In:

- MetricSpec autoscaling/v2beta1

Field | Description
--- | ---
`metricName` string | metricName is the name of the metric in question.
`target` CrossVersionObjectReference | target is the described Kubernetes object.
`targetValue` Quantity | targetValue is the target value of the metric (as a quantity).

## ObjectMetricStatus v2beta1 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta1` | `ObjectMetricStatus`

ObjectMetricStatus indicates the current value of a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).

Appears In:

- MetricStatus autoscaling/v2beta1

Field | Description
--- | ---
`currentValue` Quantity | currentValue is the current value of the metric (as a quantity).
`metricName` string | metricName is the name of the metric in question.
`target` CrossVersionObjectReference | target is the described Kubernetes object.

## ObjectReference v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `ObjectReference`

ObjectReference contains enough information to let you inspect or modify the referred object.

Appears In:

- Binding core/v1
- CronJobStatus batch/v1beta1
- CronJobStatus batch/v2alpha1
- EndpointAddress core/v1
- Event core/v1
- Event events/v1beta1
- NodeConfigSource core/v1
- PersistentVolumeSpec core/v1
- ServiceAccount core/v1
- StorageOSPersistentVolumeSource core/v1

Field | Description
--- | ---
`apiVersion` string | API version of the referent.
`fieldPath` string | 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.
`kind` string | Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
`name` string | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
`namespace` string | Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
`resourceVersion` string | 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
`uid` string | UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

## OwnerReference v1 meta

Group | Version | Kind
--- | --- | ---
`meta` | `v1` | `OwnerReference`

OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.

Appears In:

- ObjectMeta meta/v1

Field | Description
--- | ---
`apiVersion` string | API version of the referent.
`blockOwnerDeletion` boolean | 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.
`controller` boolean | If true, this reference points to the managing controller.
`kind` string | Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
`name` string | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
`uid` string | UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

## Patch v1 meta

Group | Version | Kind
--- | --- | ---
`meta` | `v1` | `Patch`

Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.

Field | Description
--- | ---

## PersistentVolumeClaimCondition v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `PersistentVolumeClaimCondition`

PersistentVolumeClaimCondition contails details about state of pvc

Appears In:

- PersistentVolumeClaimStatus core/v1

Field | Description
--- | ---
`lastProbeTime` Time | Last time we probed the condition.
`lastTransitionTime` Time | Last time the condition transitioned from one status to another.
`message` string | Human-readable message indicating details about last transition.
`reason` string | 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.
`status` string |
`type` string |

## PersistentVolumeClaimVolumeSource v1 core

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).

Appears In:

- Volume core/v1

Field | Description
--- | ---
`claimName` string | 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
`readOnly` boolean | Will force the ReadOnly setting in VolumeMounts. Default false.

## PhotonPersistentDiskVolumeSource v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `PhotonPersistentDiskVolumeSource`

Represents a Photon Controller persistent disk resource.

Appears In:

- PersistentVolumeSpec core/v1
- Volume core/v1

Field | Description
--- | ---
`fsType` string | Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
`pdID` string | ID that identifies Photon Controller persistent disk

## PodAffinity v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `PodAffinity`

Pod affinity is a group of inter pod affinity scheduling rules.

Appears In:

- Affinity core/v1

Field | Description
--- | ---
`preferredDuringSchedulingIgnoredDuringExecution` WeightedPodAffinityTerm 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.
`requiredDuringSchedulingIgnoredDuringExecution` PodAffinityTerm 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.

## PodAffinityTerm v1 core

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

Appears In:

- PodAffinity core/v1
- PodAntiAffinity core/v1
- WeightedPodAffinityTerm core/v1

Field | Description
--- | ---
`labelSelector` LabelSelector | A label query over a set of resources, in this case pods.
`namespaces` string array | namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
`topologyKey` string | 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.

## PodAntiAffinity v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `PodAntiAffinity`

Pod anti affinity is a group of inter pod anti affinity scheduling rules.

Appears In:

- Affinity core/v1

Field | Description
--- | ---
`preferredDuringSchedulingIgnoredDuringExecution` WeightedPodAffinityTerm 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.
`requiredDuringSchedulingIgnoredDuringExecution` PodAffinityTerm 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.

## PodCondition v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `PodCondition`

PodCondition contains details for the current condition of this pod.

Appears In:

- PodStatus core/v1

Field | Description
--- | ---
`lastProbeTime` Time | Last time we probed the condition.
`lastTransitionTime` Time | Last time the condition transitioned from one status to another.
`message` string | Human-readable message indicating details about last transition.
`reason` string | Unique, one-word, CamelCase reason for the condition's last transition.
`status` string | 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
`type` string | Type is the type of the condition. Currently only Ready. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

## PodDNSConfig v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `PodDNSConfig`

PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.

Appears In:

- PodSpec core/v1

Field | Description
--- | ---
`nameservers` string 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.
`options` PodDNSConfigOption 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.
`searches` string 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.

## PodDNSConfigOption v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `PodDNSConfigOption`

PodDNSConfigOption defines DNS resolver options of a pod.

Appears In:

- PodDNSConfig core/v1

Field | Description
--- | ---
`name` string | Required.
`value` string |

## PodSecurityContext v1 core

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.

Appears In:

- PodSpec core/v1

Field | Description
--- | ---
`fsGroup` integer | 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.
`runAsGroup` integer | 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.
`runAsNonRoot` boolean | 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.
`runAsUser` integer | 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.
`seLinuxOptions` SELinuxOptions | 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.
`supplementalGroups` integer 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.

## PodsMetricSource v2beta1 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta1` | `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.

Appears In:

- MetricSpec autoscaling/v2beta1

Field | Description
--- | ---
`metricName` string | metricName is the name of the metric in question
`targetAverageValue` Quantity | targetAverageValue is the target value of the average of the metric across all relevant pods (as a quantity)

## PodsMetricStatus v2beta1 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta1` | `PodsMetricStatus`

PodsMetricStatus indicates the current value of a metric describing each pod in the current scale target (for example, transactions-processed-per-second).

Appears In:

- MetricStatus autoscaling/v2beta1

Field | Description
--- | ---
`currentAverageValue` Quantity | currentAverageValue is the current value of the average of the metric across all relevant pods (as a quantity)
`metricName` string | metricName is the name of the metric in question

## PolicyRule v1 rbac

Group | Version | Kind
--- | --- | ---
`rbac.authorization.k8s.io` | `v1` | `PolicyRule`

Other API versions of this object exist: v1beta1 v1alpha1

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.

Appears In:

- ClusterRole rbac/v1
- Role rbac/v1

Field | Description
--- | ---
`apiGroups` string array | APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed.
`nonResourceURLs` string array | NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.
`resourceNames` string array | ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
`resources` string array | Resources is a list of resources this rule applies to. ResourceAll represents all resources.
`verbs` string array | Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.

## PortworxVolumeSource v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `PortworxVolumeSource`

PortworxVolumeSource represents a Portworx volume resource.

Appears In:

- PersistentVolumeSpec core/v1
- Volume core/v1

Field | Description
--- | ---
`fsType` string | 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.
`readOnly` boolean | Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
`volumeID` string | VolumeID uniquely identifies a Portworx volume

## Preconditions v1 meta

Group | Version | Kind
--- | --- | ---
`meta` | `v1` | `Preconditions`

Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.

Appears In:

- DeleteOptions meta/v1

Field | Description
--- | ---
`uid` string | Specifies the target UID.

## PreferredSchedulingTerm v1 core

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).

Appears In:

- NodeAffinity core/v1

Field | Description
--- | ---
`preference` NodeSelectorTerm | A node selector term, associated with the corresponding weight.
`weight` integer | Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.

## Probe v1 core

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.

Appears In:

- Container core/v1

Field | Description
--- | ---
`exec` ExecAction | One and only one of the following should be specified. Exec specifies the action to take.
`failureThreshold` integer | Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
`httpGet` HTTPGetAction | HTTPGet specifies the http request to perform.
`initialDelaySeconds` integer | 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
`periodSeconds` integer | How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
`successThreshold` integer | 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.
`tcpSocket` TCPSocketAction | TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported
`timeoutSeconds` integer | 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

## ProjectedVolumeSource v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `ProjectedVolumeSource`

Represents a projected volume source

Appears In:

- Volume core/v1

Field | Description
--- | ---
`defaultMode` integer | 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.
`sources` VolumeProjection array | list of volume projections

## Quantity resource core

Group | Version | Kind
--- | --- | ---
`core` | `resource` | `Quantity`

Appears In:

- EmptyDirVolumeSource core/v1
- ExternalMetricSource autoscaling/v2beta1
- ExternalMetricStatus autoscaling/v2beta1
- ObjectMetricSource autoscaling/v2beta1
- ObjectMetricStatus autoscaling/v2beta1
- PodsMetricSource autoscaling/v2beta1
- PodsMetricStatus autoscaling/v2beta1
- ResourceFieldSelector core/v1
- ResourceMetricSource autoscaling/v2beta1
- ResourceMetricStatus autoscaling/v2beta1

Field | Description
--- | ---

## QuobyteVolumeSource v1 core

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.

Appears In:

- PersistentVolumeSpec core/v1
- Volume core/v1

Field | Description
--- | ---
`group` string | Group to map volume access to Default is no group
`readOnly` boolean | ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
`registry` string | 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
`user` string | User to map volume access to Defaults to serivceaccount user
`volume` string | Volume is a string that references an already created Quobyte volume by name.

## RBDPersistentVolumeSource v1 core

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.

Appears In:

- PersistentVolumeSpec core/v1

Field | Description
--- | ---
`fsType` string | Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd
`image` string | The rados image name. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
`keyring` string | 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
`monitors` string array | A collection of Ceph monitors. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
`pool` string | The rados pool name. Default is rbd. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
`readOnly` boolean | 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
`secretRef` SecretReference | 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
`user` string | The rados user name. Default is admin. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

## RBDVolumeSource v1 core

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.

Appears In:

- Volume core/v1

Field | Description
--- | ---
`fsType` string | Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd
`image` string | The rados image name. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
`keyring` string | 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
`monitors` string array | A collection of Ceph monitors. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
`pool` string | The rados pool name. Default is rbd. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
`readOnly` boolean | 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
`secretRef` LocalObjectReference | 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
`user` string | The rados user name. Default is admin. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

## ReplicaSetCondition v1 apps

Group | Version | Kind
--- | --- | ---
`apps` | `v1` | `ReplicaSetCondition`

Other API versions of this object exist: v1beta2 v1beta1

ReplicaSetCondition describes the state of a replica set at a certain point.

Appears In:

- ReplicaSetStatus apps/v1

Field | Description
--- | ---
`lastTransitionTime` Time | The last time the condition transitioned from one status to another.
`message` string | A human readable message indicating details about the transition.
`reason` string | The reason for the condition's last transition.
`status` string | Status of the condition, one of True, False, Unknown.
`type` string | Type of replica set condition.

## ReplicationControllerCondition v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `ReplicationControllerCondition`

ReplicationControllerCondition describes the state of a replication controller at a certain point.

Appears In:

- ReplicationControllerStatus core/v1

Field | Description
--- | ---
`lastTransitionTime` Time | The last time the condition transitioned from one status to another.
`message` string | A human readable message indicating details about the transition.
`reason` string | The reason for the condition's last transition.
`status` string | Status of the condition, one of True, False, Unknown.
`type` string | Type of replication controller condition.

## ResourceAttributes v1 authorization

Group | Version | Kind
--- | --- | ---
`authorization.k8s.io` | `v1` | `ResourceAttributes`

Other API versions of this object exist: v1beta1

ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface

Appears In:

- SelfSubjectAccessReviewSpec authorization/v1
- SubjectAccessReviewSpec authorization/v1

Field | Description
--- | ---
`group` string | Group is the API Group of the Resource. "*" means all.
`name` string | Name is the name of the resource being requested for a "get" or deleted for a "delete". "" (empty) means all.
`namespace` string | Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces "" (empty) is defaulted for LocalSubjectAccessReviews "" (empty) is empty for cluster-scoped resources "" (empty) means "all" for namespace scoped resources from a SubjectAccessReview or SelfSubjectAccessReview
`resource` string | Resource is one of the existing resource types. "*" means all.
`subresource` string | Subresource is one of the existing resource types. "" means none.
`verb` string | Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all.
`version` string | Version is the API Version of the Resource. "*" means all.

## ResourceFieldSelector v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `ResourceFieldSelector`

ResourceFieldSelector represents container resources (cpu, memory) and their output format

Appears In:

- DownwardAPIVolumeFile core/v1
- EnvVarSource core/v1

Field | Description
--- | ---
`containerName` string | Container name: required for volumes, optional for env vars
`divisor` Quantity | Specifies the output format of the exposed resources, defaults to "1"
`resource` string | Required: resource to select

## ResourceMetricSource v2beta1 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta1` | `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.

Appears In:

- MetricSpec autoscaling/v2beta1

Field | Description
--- | ---
`name` string | name is the name of the resource in question.
`targetAverageUtilization` integer | 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.
`targetAverageValue` Quantity | 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.

## ResourceMetricStatus v2beta1 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta1` | `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.

Appears In:

- MetricStatus autoscaling/v2beta1

Field | Description
--- | ---
`currentAverageUtilization` integer | 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.
`currentAverageValue` Quantity | 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.
`name` string | name is the name of the resource in question.

## ResourceRequirements v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `ResourceRequirements`

ResourceRequirements describes the compute resource requirements.

Appears In:

- Container core/v1
- PersistentVolumeClaimSpec core/v1

Field | Description
--- | ---
`limits` object | Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
`requests` object | 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/

## ResourceRule v1 authorization

Group | Version | Kind
--- | --- | ---
`authorization.k8s.io` | `v1` | `ResourceRule`

Other API versions of this object exist: v1beta1

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.

Appears In:

- SubjectRulesReviewStatus authorization/v1

Field | Description
--- | ---
`apiGroups` string array | APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "*" means all.
`resourceNames` string array | ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. "*" means all.
`resources` string array | Resources is a list of resources this rule applies to. "" means all in the specified apiGroups. "/foo" represents the subresource 'foo' for all resources in the specified apiGroups.
`verbs` string array | Verb is a list of kubernetes resource API verbs, like: get, list, watch, create, update, delete, proxy. "*" means all.

## RoleRef v1 rbac

Group | Version | Kind
--- | --- | ---
`rbac.authorization.k8s.io` | `v1` | `RoleRef`

Other API versions of this object exist: v1beta1 v1alpha1

RoleRef contains information that points to the role being used

Appears In:

- ClusterRoleBinding rbac/v1
- RoleBinding rbac/v1

Field | Description
--- | ---
`apiGroup` string | APIGroup is the group for the resource being referenced
`kind` string | Kind is the type of resource being referenced
`name` string | Name is the name of resource being referenced

## RollbackConfig v1beta1 apps

Group | Version | Kind
--- | --- | ---
`apps` | `v1beta1` | `RollbackConfig`

DEPRECATED.

Appears In:

- DeploymentRollback apps/v1beta1
- DeploymentSpec apps/v1beta1

Field | Description
--- | ---
`revision` integer | The revision to rollback to. If set to 0, rollback to the last revision.

## RollingUpdateStatefulSetStrategy v1 apps

Group | Version | Kind
--- | --- | ---
`apps` | `v1` | `RollingUpdateStatefulSetStrategy`

Other API versions of this object exist: v1beta2 v1beta1

RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.

Appears In:

- StatefulSetUpdateStrategy apps/v1

Field | Description
--- | ---
`partition` integer | Partition indicates the ordinal at which the StatefulSet should be partitioned. Default value is 0.

## Rule v1alpha1 admissionregistration

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.

Appears In:

- Initializer admissionregistration/v1alpha1

Field | Description
--- | ---
`apiGroups` string 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.
`apiVersions` string 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.
`resources` string 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.

## RuleWithOperations v1beta1 admissionregistration

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.

Appears In:

- Webhook admissionregistration/v1beta1

Field | Description
--- | ---
`apiGroups` string 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.
`apiVersions` string 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.
`operations` string 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.
`resources` string 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.

## RunAsUserStrategyOptions v1beta1 extensions

Group | Version | Kind
--- | --- | ---
`extensions` | `v1beta1` | `RunAsUserStrategyOptions`

Run A sUser Strategy Options defines the strategy type and any options used to create the strategy.

Appears In:

- PodSecurityPolicySpec extensions/v1beta1

Field | Description
--- | ---
`ranges` IDRange array | Ranges are the allowed ranges of uids that may be used.
`rule` string | Rule is the strategy that will dictate the allowable RunAsUser values that may be set.

## SELinuxOptions v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `SELinuxOptions`

SELinuxOptions are the labels to be applied to the container

Appears In:

- PodSecurityContext core/v1
- SELinuxStrategyOptions extensions/v1beta1
- SELinuxStrategyOptions policy/v1beta1
- SecurityContext core/v1

Field | Description
--- | ---
`level` string | Level is SELinux level label that applies to the container.
`role` string | Role is a SELinux role label that applies to the container.
`type` string | Type is a SELinux type label that applies to the container.
`user` string | User is a SELinux user label that applies to the container.

## SELinuxStrategyOptions v1beta1 extensions

Group | Version | Kind
--- | --- | ---
`extensions` | `v1beta1` | `SELinuxStrategyOptions`

SELinux Strategy Options defines the strategy type and any options used to create the strategy.

Appears In:

- PodSecurityPolicySpec extensions/v1beta1

Field | Description
--- | ---
`rule` string | type is the strategy that will dictate the allowable labels that may be set.
`seLinuxOptions` SELinuxOptions | seLinuxOptions required to run as; required for MustRunAs More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

## Scale v1 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v1` | `Scale`

Other API versions of this object exist: v1beta2 v1beta1 v1beta1

Scale represents a scaling request for a resource.

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata.
`spec` ScaleSpec | defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status.
`status` ScaleStatus | current status of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. Read-only.

## ScaleIOPersistentVolumeSource v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `ScaleIOPersistentVolumeSource`

ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume

Appears In:

- PersistentVolumeSpec core/v1

Field | Description
--- | ---
`fsType` string | Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
`gateway` string | The host address of the ScaleIO API Gateway.
`protectionDomain` string | The name of the ScaleIO Protection Domain for the configured storage.
`readOnly` boolean | Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
`secretRef` SecretReference | SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
`sslEnabled` boolean | Flag to enable/disable SSL communication with Gateway, default false
`storageMode` string | Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.
`storagePool` string | The ScaleIO Storage Pool associated with the protection domain.
`system` string | The name of the storage system as configured in ScaleIO.
`volumeName` string | The name of a volume already created in the ScaleIO system that is associated with this volume source.

## ScaleIOVolumeSource v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `ScaleIOVolumeSource`

ScaleIOVolumeSource represents a persistent ScaleIO volume

Appears In:

- Volume core/v1

Field | Description
--- | ---
`fsType` string | Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
`gateway` string | The host address of the ScaleIO API Gateway.
`protectionDomain` string | The name of the ScaleIO Protection Domain for the configured storage.
`readOnly` boolean | Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
`secretRef` LocalObjectReference | SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
`sslEnabled` boolean | Flag to enable/disable SSL communication with Gateway, default false
`storageMode` string | Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.
`storagePool` string | The ScaleIO Storage Pool associated with the protection domain.
`system` string | The name of the storage system as configured in ScaleIO.
`volumeName` string | The name of a volume already created in the ScaleIO system that is associated with this volume source.

## SecretEnvSource v1 core

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.

Appears In:

- EnvFromSource core/v1

Field | Description
--- | ---
`name` string | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
`optional` boolean | Specify whether the Secret must be defined

## SecretKeySelector v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `SecretKeySelector`

SecretKeySelector selects a key of a Secret.

Appears In:

- EnvVarSource core/v1

Field | Description
--- | ---
`key` string | The key of the secret to select from. Must be a valid secret key.
`name` string | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
`optional` boolean | Specify whether the Secret or it's key must be defined

## SecretProjection v1 core

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.

Appears In:

- VolumeProjection core/v1

Field | Description
--- | ---
`items` KeyToPath 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 '..'.
`name` string | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
`optional` boolean | Specify whether the Secret or its key must be defined

## SecretReference v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `SecretReference`

SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace

Appears In:

- CSIPersistentVolumeSource core/v1
- CephFSPersistentVolumeSource core/v1
- FlexPersistentVolumeSource core/v1
- ISCSIPersistentVolumeSource core/v1
- RBDPersistentVolumeSource core/v1
- ScaleIOPersistentVolumeSource core/v1

Field | Description
--- | ---
`name` string | Name is unique within a namespace to reference a secret resource.
`namespace` string | Namespace defines the space within which the secret name must be unique.

## SecretVolumeSource v1 core

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.

Appears In:

- Volume core/v1

Field | Description
--- | ---
`defaultMode` integer | Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
`items` KeyToPath 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 '..'.
`optional` boolean | Specify whether the Secret or it's keys must be defined
`secretName` string | Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

## SecurityContext v1 core

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.

Appears In:

- Container core/v1

Field | Description
--- | ---
`allowPrivilegeEscalation` boolean | 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
`capabilities` Capabilities | The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.
`privileged` boolean | Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.
`readOnlyRootFilesystem` boolean | Whether this container has a read-only root filesystem. Default is false.
`runAsGroup` integer | 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.
`runAsNonRoot` boolean | 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.
`runAsUser` integer | 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.
`seLinuxOptions` SELinuxOptions | 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.

## ServerAddressByClientCIDR v1 meta

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.

Appears In:

- APIGroup meta/v1
- APIVersions meta/v1

Field | Description
--- | ---
`clientCIDR` string | The CIDR with which clients can match their IP to figure out the server address that they should use.
`serverAddress` string | Address of this server, suitable for a client that matches the above CIDR. This can be a hostname, hostname:port, IP or IP:port.

## ServicePort v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `ServicePort`

ServicePort contains information on service's port.

Appears In:

- ServiceSpec core/v1

Field | Description
--- | ---
`name` string | 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.
`nodePort` integer | 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
`port` integer | The port that will be exposed by this service.
`protocol` string | The IP protocol for this port. Supports "TCP" and "UDP". 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

## ServiceReference v1 apiregistration

Group | Version | Kind
--- | --- | ---
`apiregistration.k8s.io` | `v1` | `ServiceReference`

Other API versions of this object exist: v1beta1 v1beta1

ServiceReference holds a reference to Service.legacy.k8s.io

Appears In:

- APIServiceSpec apiregistration/v1

Field | Description
--- | ---
`name` string | Name is the name of the service
`namespace` string | Namespace is the namespace of the service

## SessionAffinityConfig v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `SessionAffinityConfig`

SessionAffinityConfig represents the configurations of session affinity.

Appears In:

- ServiceSpec core/v1

Field | Description
--- | ---
`clientIP` ClientIPConfig | clientIP contains the configurations of Client IP based session affinity.

## StatefulSetCondition v1 apps

Group | Version | Kind
--- | --- | ---
`apps` | `v1` | `StatefulSetCondition`

Other API versions of this object exist: v1beta2 v1beta1

StatefulSetCondition describes the state of a statefulset at a certain point.

Appears In:

- StatefulSetStatus apps/v1

Field | Description
--- | ---
`lastTransitionTime` Time | Last time the condition transitioned from one status to another.
`message` string | A human readable message indicating details about the transition.
`reason` string | The reason for the condition's last transition.
`status` string | Status of the condition, one of True, False, Unknown.
`type` string | Type of statefulset condition.

## StatefulSetUpdateStrategy v1 apps

Group | Version | Kind
--- | --- | ---
`apps` | `v1` | `StatefulSetUpdateStrategy`

Other API versions of this object exist: v1beta2 v1beta1

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.

Appears In:

- StatefulSetSpec apps/v1

Field | Description
--- | ---
`rollingUpdate` RollingUpdateStatefulSetStrategy | RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType.
`type` string | Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate.

## Status v1 meta

Group | Version | Kind
--- | --- | ---
`meta` | `v1` | `Status`

Status is a return value for calls that don't return other objects.

Appears In:

- Initializers meta/v1

Field | Description
--- | ---
`apiVersion` string | 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
`code` integer | Suggested HTTP return code for this status, 0 if not set.
`details` StatusDetails | 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.
`kind` string | 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
`message` string | A human-readable description of the status of this operation.
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
`reason` string | 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.
`status` string | Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

## StatusCause v1 meta

Group | Version | Kind
--- | --- | ---
`meta` | `v1` | `StatusCause`

StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.

Appears In:

- StatusDetails meta/v1

Field | Description
--- | ---
`field` string | 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"
`message` string | A human-readable description of the cause of the error. This field may be presented as-is to a reader.
`reason` string | A machine-readable description of the cause of the error. If this value is empty there is no information available.

## StatusDetails v1 meta

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.

Appears In:

- Status meta/v1

Field | Description
--- | ---
`causes` StatusCause array | The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.
`group` string | The group attribute of the resource associated with the status StatusReason.
`kind` string | 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
`name` string | The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).
`retryAfterSeconds` integer | 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.
`uid` string | UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids

## StorageOSPersistentVolumeSource v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `StorageOSPersistentVolumeSource`

Represents a StorageOS persistent volume resource.

Appears In:

- PersistentVolumeSpec core/v1

Field | Description
--- | ---
`fsType` string | Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
`readOnly` boolean | Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
`secretRef` ObjectReference | SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
`volumeName` string | VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
`volumeNamespace` string | 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.

## StorageOSVolumeSource v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `StorageOSVolumeSource`

Represents a StorageOS persistent volume resource.

Appears In:

- Volume core/v1

Field | Description
--- | ---
`fsType` string | Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
`readOnly` boolean | Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
`secretRef` LocalObjectReference | SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
`volumeName` string | VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
`volumeNamespace` string | 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.

## Subject v1 rbac

Group | Version | Kind
--- | --- | ---
`rbac.authorization.k8s.io` | `v1` | `Subject`

Other API versions of this object exist: v1beta1 v1alpha1

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.

Appears In:

- ClusterRoleBinding rbac/v1
- RoleBinding rbac/v1

Field | Description
--- | ---
`apiGroup` string | APIGroup holds the API group of the referenced subject. Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects.
`kind` string | Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error.
`name` string | Name of the object being referenced.
`namespace` string | Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error.

## SubjectRulesReviewStatus v1 authorization

Group | Version | Kind
--- | --- | ---
`authorization.k8s.io` | `v1` | `SubjectRulesReviewStatus`

Other API versions of this object exist: v1beta1

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.

Appears In:

- SelfSubjectRulesReview authorization/v1

Field | Description
--- | ---
`evaluationError` string | EvaluationError can appear in combination with Rules. It indicates an error occurred during rule evaluation, such as an authorizer that doesn't support rule evaluation, and that ResourceRules and/or NonResourceRules may be incomplete.
`incomplete` boolean | Incomplete is true when the rules returned by this call are incomplete. This is most commonly encountered when an authorizer, such as an external authorizer, doesn't support rules evaluation.
`nonResourceRules` NonResourceRule 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.
`resourceRules` ResourceRule 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.

## SupplementalGroupsStrategyOptions v1beta1 extensions

Group | Version | Kind
--- | --- | ---
`extensions` | `v1beta1` | `SupplementalGroupsStrategyOptions`

SupplementalGroupsStrategyOptions defines the strategy type and options used to create the strategy.

Appears In:

- PodSecurityPolicySpec extensions/v1beta1

Field | Description
--- | ---
`ranges` IDRange 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.
`rule` string | Rule is the strategy that will dictate what supplemental groups is used in the SecurityContext.

## TCPSocketAction v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `TCPSocketAction`

TCPSocketAction describes an action based on opening a socket

Appears In:

- Handler core/v1
- Probe core/v1

Field | Description
--- | ---
`host` string | 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.

## Taint v1 core

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.

Appears In:

- NodeSpec core/v1

Field | Description
--- | ---
`effect` string | Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.
`key` string | Required. The taint key to be applied to a node.
`timeAdded` Time | TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints.
`value` string | Required. The taint value corresponding to the taint key.

## Time v1 meta

Group | Version | Kind
--- | --- | ---
`meta` | `v1` | `Time`

Appears In:

- APIServiceCondition apiregistration/v1
- APIServiceCondition apiregistration/v1beta1
- CertificateSigningRequestCondition certificates/v1beta1
- ContainerStateRunning core/v1
- ContainerStateTerminated core/v1
- CronJobStatus batch/v1beta1
- CronJobStatus batch/v2alpha1
- CustomResourceDefinitionCondition apiextensions/v1beta1
- DaemonSetCondition apps/v1
- DaemonSetCondition apps/v1beta2
- DaemonSetCondition extensions/v1beta1
- DeploymentCondition apps/v1
- DeploymentCondition apps/v1beta2
- DeploymentCondition apps/v1beta1
- DeploymentCondition extensions/v1beta1
- Event core/v1
- Event events/v1beta1
- HorizontalPodAutoscalerCondition autoscaling/v2beta1
- HorizontalPodAutoscalerStatus autoscaling/v1
- HorizontalPodAutoscalerStatus autoscaling/v2beta1
- JobCondition batch/v1
- JobStatus batch/v1
- NodeCondition core/v1
- ObjectMeta meta/v1
- PersistentVolumeClaimCondition core/v1
- PodCondition core/v1
- PodStatus core/v1
- ReplicaSetCondition apps/v1
- ReplicaSetCondition apps/v1beta2
- ReplicaSetCondition extensions/v1beta1
- ReplicationControllerCondition core/v1
- StatefulSetCondition apps/v1
- StatefulSetCondition apps/v1beta2
- StatefulSetCondition apps/v1beta1
- Taint core/v1
- VolumeError storage/v1beta1
- VolumeError storage/v1alpha1

Field | Description
--- | ---

## Toleration v1 core

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>.

Appears In:

- PodSpec core/v1

Field | Description
--- | ---
`effect` string | Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
`key` string | 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.
`operator` string | 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.
`tolerationSeconds` integer | 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.
`value` string | Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.

## UserInfo v1 authentication

Group | Version | Kind
--- | --- | ---
`authentication.k8s.io` | `v1` | `UserInfo`

Other API versions of this object exist: v1beta1

UserInfo holds the information about the user needed to implement the user.Info interface.

Appears In:

- TokenReviewStatus authentication/v1

Field | Description
--- | ---
`extra` object | Any additional information provided by the authenticator.
`groups` string array | The names of groups this user is a part of.
`uid` string | A unique value that identifies this user across time. If this user is deleted and another user by the same name is added, they will have different UIDs.
`username` string | The name that uniquely identifies this user among all active users.

## VolumeAttachmentSource v1beta1 storage

Group | Version | Kind
--- | --- | ---
`storage.k8s.io` | `v1beta1` | `VolumeAttachmentSource`

Other API versions of this object exist: v1alpha1

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.

Appears In:

- VolumeAttachmentSpec storage/v1beta1

Field | Description
--- | ---
`persistentVolumeName` string | Name of the persistent volume to attach.

## VolumeDevice v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `VolumeDevice`

volumeDevice describes a mapping of a raw block device within a container.

Appears In:

- Container core/v1

Field | Description
--- | ---
`devicePath` string | devicePath is the path inside of the container that the device will be mapped to.
`name` string | name must match the name of a persistentVolumeClaim in the pod

## VolumeError v1beta1 storage

Group | Version | Kind
--- | --- | ---
`storage.k8s.io` | `v1beta1` | `VolumeError`

Other API versions of this object exist: v1alpha1

VolumeError captures an error encountered during a volume operation.

Appears In:

- VolumeAttachmentStatus storage/v1beta1

Field | Description
--- | ---
`message` string | String detailing the error encountered during Attach or Detach operation. This string maybe logged, so it should not contain sensitive information.
`time` Time | Time the error was encountered.

## VolumeMount v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `VolumeMount`

VolumeMount describes a mounting of a Volume within a container.

Appears In:

- Container core/v1
- PodPresetSpec settings/v1alpha1

Field | Description
--- | ---
`mountPath` string | Path within the container at which the volume should be mounted. Must not contain ':'.
`mountPropagation` string | mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationHostToContainer is used. This field is beta in 1.10.
`name` string | This must match the Name of a Volume.
`readOnly` boolean | Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
`subPath` string | Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

## VolumeNodeAffinity v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `VolumeNodeAffinity`

VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from.

Appears In:

- PersistentVolumeSpec core/v1

Field | Description
--- | ---
`required` NodeSelector | Required specifies hard node constraints that must be met.

## VolumeProjection v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `VolumeProjection`

Projection that may be projected along with other supported volume types

Appears In:

- ProjectedVolumeSource core/v1

Field | Description
--- | ---
`configMap` ConfigMapProjection | information about the configMap data to project
`downwardAPI` DownwardAPIProjection | information about the downwardAPI data to project
`secret` SecretProjection | information about the secret data to project

## VsphereVirtualDiskVolumeSource v1 core

Group | Version | Kind
--- | --- | ---
`core` | `v1` | `VsphereVirtualDiskVolumeSource`

Represents a vSphere volume resource.

Appears In:

- PersistentVolumeSpec core/v1
- Volume core/v1

Field | Description
--- | ---
`fsType` string | Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
`storagePolicyID` string | Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
`storagePolicyName` string | Storage Policy Based Management (SPBM) profile name.
`volumePath` string | Path that identifies vSphere volume vmdk

## WatchEvent v1 meta

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.
`type` string |

## Webhook v1beta1 admissionregistration

Group | Version | Kind
--- | --- | ---
`admissionregistration.k8s.io` | `v1beta1` | `Webhook`

Webhook describes an admission webhook and the resources and operations it applies to.

Appears In:

- MutatingWebhookConfiguration admissionregistration/v1beta1
- ValidatingWebhookConfiguration admissionregistration/v1beta1

Field | Description
--- | ---
`clientConfig` WebhookClientConfig | ClientConfig defines how to communicate with the hook. Required
`failurePolicy` string | FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Ignore.
`name` string | The name of the admission webhook. Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where "imagepolicy" is the name of the webhook, and kubernetes.io is the name of the organization. Required.
`namespaceSelector` LabelSelector | 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.
`rules` RuleWithOperations 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.

## WebhookClientConfig v1beta1 admissionregistration

Group | Version | Kind
--- | --- | ---
`admissionregistration.k8s.io` | `v1beta1` | `WebhookClientConfig`

WebhookClientConfig contains the information to make a TLS connection with the webhook

Appears In:

- Webhook admissionregistration/v1beta1

Field | Description
--- | ---
`caBundle` string | `caBundle` is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. Required.
`service` ServiceReference | `service` is a reference to the service for this webhook. Either `service` or `url` must be specified. If the webhook is running within the cluster, then you should use `service`. If there is only one port open for the service, that port will be used. If there are multiple ports open, port 443 will be used if it is open, otherwise it is an error.
`url` string | `url` gives the location of the webhook, in standard URL form (`[scheme://]host:port/path`). Exactly one of `url` or `service` must be specified. The `host` should not refer to a service running in the cluster; use the `service` field instead. The host might be resolved via external DNS in some apiservers (e.g., `kube-apiserver` cannot resolve in-cluster DNS as that would be a layering violation). `host` may also be an IP address. Please note that using `localhost` or `127.0.0.1` as a `host` is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster. The scheme must be "https"; the URL must begin with "https://&#34;. 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.

## WeightedPodAffinityTerm v1 core

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)

Appears In:

- PodAffinity core/v1
- PodAntiAffinity core/v1

Field | Description
--- | ---
`podAffinityTerm` PodAffinityTerm | Required. A pod affinity term, associated with the corresponding weight.
`weight` integer | weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

# OLD API VERSIONS

This section contains older versions of resources shown above.

# APIService v1beta1 apiregistration.k8s.io

Group | Version | Kind
--- | --- | ---
`apiregistration.k8s.io` | `v1beta1` | `APIService`

Other api versions of this object exist: v1

APIService represents a server for a particular GroupVersion. Name must be "version.group".

Appears In:

- APIServiceList apiregistration/v1beta1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta |
`spec` APIServiceSpec | Spec contains information for locating and communicating with a server
`status` APIServiceStatus | Status contains derived information about an API server

### APIServiceSpec v1beta1 apiregistration

Appears In:

- APIService apiregistration/v1beta1

Field | Description
--- | ---
`caBundle` string | CABundle is a PEM encoded CA bundle which will be used to validate an API server's serving certificate.
`group` string | Group is the API group name this server hosts
`groupPriorityMinimum` integer | GroupPriorityMininum is the priority this group should have at least. Higher priority means that the group is preferred by clients over lower priority ones. Note that other versions of this group might specify even higher GroupPriorityMininum values such that the whole group gets a higher priority. The primary sort is based on GroupPriorityMinimum, ordered highest number to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) We'd recommend something like: *.k8s.io (except extensions) at 18000 and PaaSes (OpenShift, Deis) are recommended to be in the 2000s
`insecureSkipTLSVerify` boolean | InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. This is strongly discouraged. You should use the CABundle instead.
`service` ServiceReference | 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.
`version` string | Version is the API version this server hosts. For example, "v1"
`versionPriority` integer | VersionPriority controls the ordering of this API version inside of its group. Must be greater than zero. The primary sort is based on VersionPriority, ordered highest to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) Since it's inside of a group, the number can be small, probably in the 10s.

### APIServiceStatus v1beta1 apiregistration

Appears In:

- APIService apiregistration/v1beta1

Field | Description
--- | ---
`conditions` APIServiceCondition array patch type: merge patch merge key: type | Current service state of apiService.

### APIServiceList v1beta1 apiregistration

Field | Description
--- | ---
`apiVersion` string | 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
`items` APIService array |
`kind` string | 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
`metadata` ListMeta |

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create an APIService

### HTTP Request

`POST /apis/apiregistration.k8s.io/v1beta1/apiservices`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` APIService |

### Response

Code | Description
--- | ---
200 APIService | OK
201 APIService | Created
202 APIService | Accepted

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified APIService

### HTTP Request

`PATCH /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the APIService

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 APIService | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified APIService

### HTTP Request

`PUT /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the APIService

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` APIService |

### Response

Code | Description
--- | ---
200 APIService | OK
201 APIService | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete an APIService

### HTTP Request

`DELETE /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the APIService

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of APIService

### HTTP Request

`DELETE /apis/apiregistration.k8s.io/v1beta1/apiservices`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified APIService

### HTTP Request

`GET /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the APIService

### Query Parameters

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.

### Response

Code | Description
--- | ---
200 APIService | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind APIService

### HTTP Request

`GET /apis/apiregistration.k8s.io/v1beta1/apiservices`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 APIServiceList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind APIService

### HTTP Request

`GET /apis/apiregistration.k8s.io/v1beta1/watch/apiservices/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the APIService

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of APIService

### HTTP Request

`GET /apis/apiregistration.k8s.io/v1beta1/watch/apiservices`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Status Operations

See supported operations below...

## Replace Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace status of the specified APIService

### HTTP Request

`PUT /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the APIService

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` APIService |

### Response

Code | Description
--- | ---
200 APIService | OK
201 APIService | Created

# APIServiceCondition v1beta1 apiregistration.k8s.io

Group | Version | Kind
--- | --- | ---
`apiregistration.k8s.io` | `v1beta1` | `APIServiceCondition`

Other api versions of this object exist: v1
Appears In:

- APIServiceStatus apiregistration/v1beta1

Field | Description
--- | ---
`lastTransitionTime` Time | Last time the condition transitioned from one status to another.
`message` string | Human-readable message indicating details about last transition.
`reason` string | Unique, one-word, CamelCase reason for the condition's last transition.
`status` string | Status is the status of the condition. Can be True, False, Unknown.
`type` string | Type is the type of the condition.

# AggregationRule v1beta1 rbac.authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`rbac.authorization.k8s.io` | `v1beta1` | `AggregationRule`

Other api versions of this object exist: v1 v1alpha1

AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole

Appears In:

- ClusterRole rbac/v1beta1

Field | Description
--- | ---
`clusterRoleSelectors` LabelSelector 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

# AggregationRule v1alpha1 rbac.authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`rbac.authorization.k8s.io` | `v1alpha1` | `AggregationRule`

Other api versions of this object exist: v1 v1beta1

AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole

Appears In:

- ClusterRole rbac/v1alpha1

Field | Description
--- | ---
`clusterRoleSelectors` LabelSelector 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

# AllowedFlexVolume v1beta1 policy

Group | Version | Kind
--- | --- | ---
`policy` | `v1beta1` | `AllowedFlexVolume`

AllowedFlexVolume represents a single Flexvolume that is allowed to be used.

Appears In:

- PodSecurityPolicySpec policy/v1beta1

Field | Description
--- | ---
`driver` string | Driver is the name of the Flexvolume driver.

# AllowedHostPath v1beta1 policy

Group | Version | Kind
--- | --- | ---
`policy` | `v1beta1` | `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.

Appears In:

- PodSecurityPolicySpec policy/v1beta1

Field | Description
--- | ---
`pathPrefix` string | is the path prefix that the host volume must match. It does not support `*`. Trailing slashes are trimmed when validating the path prefix with a host path. Examples: `/foo` would allow `/foo`, `/foo/` and `/foo/bar` `/foo` would not allow `/food` or `/etc/foo`

# ClusterRole v1beta1 rbac.authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`rbac.authorization.k8s.io` | `v1beta1` | `ClusterRole`

Other api versions of this object exist: v1 v1alpha1

ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding.

Appears In:

- ClusterRoleList rbac/v1beta1

Field | Description
--- | ---
`aggregationRule` AggregationRule | 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.
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata.
`rules` PolicyRule array | Rules holds all the PolicyRules for this ClusterRole

### ClusterRoleList v1beta1 rbac

Field | Description
--- | ---
`apiVersion` string | 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
`items` ClusterRole array | Items is a list of ClusterRoles
`kind` string | 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
`metadata` ListMeta | Standard object's metadata.

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a ClusterRole

### HTTP Request

`POST /apis/rbac.authorization.k8s.io/v1beta1/clusterroles`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ClusterRole |

### Response

Code | Description
--- | ---
200 ClusterRole | OK
201 ClusterRole | Created
202 ClusterRole | Accepted

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified ClusterRole

### HTTP Request

`PATCH /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ClusterRole

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 ClusterRole | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified ClusterRole

### HTTP Request

`PUT /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ClusterRole

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ClusterRole |

### Response

Code | Description
--- | ---
200 ClusterRole | OK
201 ClusterRole | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a ClusterRole

### HTTP Request

`DELETE /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ClusterRole

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of ClusterRole

### HTTP Request

`DELETE /apis/rbac.authorization.k8s.io/v1beta1/clusterroles`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified ClusterRole

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ClusterRole

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 ClusterRole | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind ClusterRole

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1beta1/clusterroles`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 ClusterRoleList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind ClusterRole

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1beta1/watch/clusterroles/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ClusterRole

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of ClusterRole

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1beta1/watch/clusterroles`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

# ClusterRole v1alpha1 rbac.authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`rbac.authorization.k8s.io` | `v1alpha1` | `ClusterRole`

Other api versions of this object exist: v1 v1beta1

ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding.

Appears In:

- ClusterRoleList rbac/v1alpha1

Field | Description
--- | ---
`aggregationRule` AggregationRule | 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.
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata.
`rules` PolicyRule array | Rules holds all the PolicyRules for this ClusterRole

### ClusterRoleList v1alpha1 rbac

Field | Description
--- | ---
`apiVersion` string | 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
`items` ClusterRole array | Items is a list of ClusterRoles
`kind` string | 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
`metadata` ListMeta | Standard object's metadata.

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a ClusterRole

### HTTP Request

`POST /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ClusterRole |

### Response

Code | Description
--- | ---
202 ClusterRole | Accepted
200 ClusterRole | OK
201 ClusterRole | Created

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified ClusterRole

### HTTP Request

`PATCH /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ClusterRole

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 ClusterRole | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified ClusterRole

### HTTP Request

`PUT /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ClusterRole

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ClusterRole |

### Response

Code | Description
--- | ---
201 ClusterRole | Created
200 ClusterRole | OK

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a ClusterRole

### HTTP Request

`DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ClusterRole

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of ClusterRole

### HTTP Request

`DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified ClusterRole

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ClusterRole

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 ClusterRole | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind ClusterRole

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 ClusterRoleList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind ClusterRole

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterroles/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ClusterRole

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of ClusterRole

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterroles`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

# ClusterRoleBinding v1beta1 rbac.authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`rbac.authorization.k8s.io` | `v1beta1` | `ClusterRoleBinding`

Other api versions of this object exist: v1 v1alpha1

ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject.

Appears In:

- ClusterRoleBindingList rbac/v1beta1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata.
`roleRef` RoleRef | RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
`subjects` Subject array | Subjects holds references to the objects the role applies to.

### ClusterRoleBindingList v1beta1 rbac

Field | Description
--- | ---
`apiVersion` string | 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
`items` ClusterRoleBinding array | Items is a list of ClusterRoleBindings
`kind` string | 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
`metadata` ListMeta | Standard object's metadata.

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a ClusterRoleBinding

### HTTP Request

`POST /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ClusterRoleBinding |

### Response

Code | Description
--- | ---
202 ClusterRoleBinding | Accepted
200 ClusterRoleBinding | OK
201 ClusterRoleBinding | Created

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified ClusterRoleBinding

### HTTP Request

`PATCH /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ClusterRoleBinding

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 ClusterRoleBinding | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified ClusterRoleBinding

### HTTP Request

`PUT /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ClusterRoleBinding

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ClusterRoleBinding |

### Response

Code | Description
--- | ---
200 ClusterRoleBinding | OK
201 ClusterRoleBinding | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a ClusterRoleBinding

### HTTP Request

`DELETE /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ClusterRoleBinding

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of ClusterRoleBinding

### HTTP Request

`DELETE /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified ClusterRoleBinding

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ClusterRoleBinding

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 ClusterRoleBinding | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind ClusterRoleBinding

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 ClusterRoleBindingList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind ClusterRoleBinding

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1beta1/watch/clusterrolebindings/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ClusterRoleBinding

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of ClusterRoleBinding

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1beta1/watch/clusterrolebindings`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

# ClusterRoleBinding v1alpha1 rbac.authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`rbac.authorization.k8s.io` | `v1alpha1` | `ClusterRoleBinding`

Other api versions of this object exist: v1 v1beta1

ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject.

Appears In:

- ClusterRoleBindingList rbac/v1alpha1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata.
`roleRef` RoleRef | RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
`subjects` Subject array | Subjects holds references to the objects the role applies to.

### ClusterRoleBindingList v1alpha1 rbac

Field | Description
--- | ---
`apiVersion` string | 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
`items` ClusterRoleBinding array | Items is a list of ClusterRoleBindings
`kind` string | 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
`metadata` ListMeta | Standard object's metadata.

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a ClusterRoleBinding

### HTTP Request

`POST /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ClusterRoleBinding |

### Response

Code | Description
--- | ---
200 ClusterRoleBinding | OK
201 ClusterRoleBinding | Created
202 ClusterRoleBinding | Accepted

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified ClusterRoleBinding

### HTTP Request

`PATCH /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ClusterRoleBinding

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 ClusterRoleBinding | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified ClusterRoleBinding

### HTTP Request

`PUT /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ClusterRoleBinding

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ClusterRoleBinding |

### Response

Code | Description
--- | ---
200 ClusterRoleBinding | OK
201 ClusterRoleBinding | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a ClusterRoleBinding

### HTTP Request

`DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ClusterRoleBinding

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of ClusterRoleBinding

### HTTP Request

`DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified ClusterRoleBinding

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ClusterRoleBinding

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 ClusterRoleBinding | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind ClusterRoleBinding

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 ClusterRoleBindingList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind ClusterRoleBinding

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterrolebindings/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ClusterRoleBinding

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of ClusterRoleBinding

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterrolebindings`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

# ControllerRevision v1beta2 apps

Group | Version | Kind
--- | --- | ---
`apps` | `v1beta2` | `ControllerRevision`

Other api versions of this object exist: v1 v1beta1

DEPRECATED - This group version of ControllerRevision is deprecated by apps/v1/ControllerRevision. See the release notes for more information. ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers.

Appears In:

- ControllerRevisionList apps/v1beta2

Field | Description
--- | ---
`apiVersion` string | 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.
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`revision` integer | Revision indicates the revision of the state represented by Data.

### ControllerRevisionList v1beta2 apps

Field | Description
--- | ---
`apiVersion` string | 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
`items` ControllerRevision array | Items is the list of ControllerRevisions
`kind` string | 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
`metadata` ListMeta | More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a ControllerRevision

### HTTP Request

`POST /apis/apps/v1beta2/namespaces/{namespace}/controllerrevisions`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ControllerRevision |

### Response

Code | Description
--- | ---
201 ControllerRevision | Created
202 ControllerRevision | Accepted
200 ControllerRevision | OK

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified ControllerRevision

### HTTP Request

`PATCH /apis/apps/v1beta2/namespaces/{namespace}/controllerrevisions/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ControllerRevision
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 ControllerRevision | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified ControllerRevision

### HTTP Request

`PUT /apis/apps/v1beta2/namespaces/{namespace}/controllerrevisions/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ControllerRevision
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ControllerRevision |

### Response

Code | Description
--- | ---
201 ControllerRevision | Created
200 ControllerRevision | OK

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a ControllerRevision

### HTTP Request

`DELETE /apis/apps/v1beta2/namespaces/{namespace}/controllerrevisions/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ControllerRevision
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of ControllerRevision

### HTTP Request

`DELETE /apis/apps/v1beta2/namespaces/{namespace}/controllerrevisions`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified ControllerRevision

### HTTP Request

`GET /apis/apps/v1beta2/namespaces/{namespace}/controllerrevisions/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ControllerRevision
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

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.

### Response

Code | Description
--- | ---
200 ControllerRevision | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind ControllerRevision

### HTTP Request

`GET /apis/apps/v1beta2/namespaces/{namespace}/controllerrevisions`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 ControllerRevisionList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind ControllerRevision

### HTTP Request

`GET /apis/apps/v1beta2/controllerrevisions`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 ControllerRevisionList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind ControllerRevision

### HTTP Request

`GET /apis/apps/v1beta2/watch/namespaces/{namespace}/controllerrevisions/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ControllerRevision
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of ControllerRevision

### HTTP Request

`GET /apis/apps/v1beta2/watch/namespaces/{namespace}/controllerrevisions`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of ControllerRevision

### HTTP Request

`GET /apis/apps/v1beta2/watch/controllerrevisions`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

# ControllerRevision v1beta1 apps

Group | Version | Kind
--- | --- | ---
`apps` | `v1beta1` | `ControllerRevision`

Other api versions of this object exist: v1 v1beta2

DEPRECATED - This group version of ControllerRevision is deprecated by apps/v1beta2/ControllerRevision. See the release notes for more information. ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers.

Appears In:

- ControllerRevisionList apps/v1beta1

Field | Description
--- | ---
`apiVersion` string | 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.
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`revision` integer | Revision indicates the revision of the state represented by Data.

### ControllerRevisionList v1beta1 apps

Field | Description
--- | ---
`apiVersion` string | 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
`items` ControllerRevision array | Items is the list of ControllerRevisions
`kind` string | 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
`metadata` ListMeta | More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a ControllerRevision

### HTTP Request

`POST /apis/apps/v1beta1/namespaces/{namespace}/controllerrevisions`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ControllerRevision |

### Response

Code | Description
--- | ---
200 ControllerRevision | OK
201 ControllerRevision | Created
202 ControllerRevision | Accepted

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified ControllerRevision

### HTTP Request

`PATCH /apis/apps/v1beta1/namespaces/{namespace}/controllerrevisions/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ControllerRevision
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 ControllerRevision | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified ControllerRevision

### HTTP Request

`PUT /apis/apps/v1beta1/namespaces/{namespace}/controllerrevisions/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ControllerRevision
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ControllerRevision |

### Response

Code | Description
--- | ---
200 ControllerRevision | OK
201 ControllerRevision | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a ControllerRevision

### HTTP Request

`DELETE /apis/apps/v1beta1/namespaces/{namespace}/controllerrevisions/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ControllerRevision
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of ControllerRevision

### HTTP Request

`DELETE /apis/apps/v1beta1/namespaces/{namespace}/controllerrevisions`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified ControllerRevision

### HTTP Request

`GET /apis/apps/v1beta1/namespaces/{namespace}/controllerrevisions/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ControllerRevision
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

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.

### Response

Code | Description
--- | ---
200 ControllerRevision | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind ControllerRevision

### HTTP Request

`GET /apis/apps/v1beta1/namespaces/{namespace}/controllerrevisions`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 ControllerRevisionList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind ControllerRevision

### HTTP Request

`GET /apis/apps/v1beta1/controllerrevisions`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 ControllerRevisionList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind ControllerRevision

### HTTP Request

`GET /apis/apps/v1beta1/watch/namespaces/{namespace}/controllerrevisions/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ControllerRevision
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of ControllerRevision

### HTTP Request

`GET /apis/apps/v1beta1/watch/namespaces/{namespace}/controllerrevisions`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of ControllerRevision

### HTTP Request

`GET /apis/apps/v1beta1/watch/controllerrevisions`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

# CronJob v2alpha1 batch

Group | Version | Kind
--- | --- | ---
`batch` | `v2alpha1` | `CronJob`

Other api versions of this object exist: v1beta1

CronJob represents the configuration of a single cron job.

Appears In:

- CronJobList batch/v2alpha1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`spec` CronJobSpec | 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
`status` CronJobStatus | Current status of a cron job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

### CronJobSpec v2alpha1 batch

Appears In:

- CronJob batch/v2alpha1

Field | Description
--- | ---
`concurrencyPolicy` string | 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
`failedJobsHistoryLimit` integer | The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified.
`jobTemplate` JobTemplateSpec | Specifies the job that will be created when executing a CronJob.
`schedule` string | The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
`startingDeadlineSeconds` integer | 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.
`successfulJobsHistoryLimit` integer | The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified.
`suspend` boolean | This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.

### CronJobStatus v2alpha1 batch

Appears In:

- CronJob batch/v2alpha1

Field | Description
--- | ---
`active` ObjectReference array | A list of pointers to currently running jobs.
`lastScheduleTime` Time | Information when was the last time the job was successfully scheduled.

### CronJobList v2alpha1 batch

Field | Description
--- | ---
`apiVersion` string | 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
`items` CronJob array | items is the list of CronJobs.
`kind` string | 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
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a CronJob

### HTTP Request

`POST /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` CronJob |

### Response

Code | Description
--- | ---
200 CronJob | OK
201 CronJob | Created
202 CronJob | Accepted

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified CronJob

### HTTP Request

`PATCH /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CronJob
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 CronJob | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified CronJob

### HTTP Request

`PUT /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CronJob
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` CronJob |

### Response

Code | Description
--- | ---
200 CronJob | OK
201 CronJob | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a CronJob

### HTTP Request

`DELETE /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CronJob
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of CronJob

### HTTP Request

`DELETE /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified CronJob

### HTTP Request

`GET /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CronJob
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Response

Code | Description
--- | ---
200 CronJob | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind CronJob

### HTTP Request

`GET /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 CronJobList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind CronJob

### HTTP Request

`GET /apis/batch/v2alpha1/cronjobs`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 CronJobList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind CronJob

### HTTP Request

`GET /apis/batch/v2alpha1/watch/namespaces/{namespace}/cronjobs/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CronJob
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of CronJob

### HTTP Request

`GET /apis/batch/v2alpha1/watch/namespaces/{namespace}/cronjobs`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of CronJob

### HTTP Request

`GET /apis/batch/v2alpha1/watch/cronjobs`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Status Operations

See supported operations below...

## Patch Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update status of the specified CronJob

### HTTP Request

`PATCH /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CronJob
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 CronJob | OK

## Read Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read status of the specified CronJob

### HTTP Request

`GET /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CronJob
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 CronJob | OK

## Replace Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace status of the specified CronJob

### HTTP Request

`PUT /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CronJob
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` CronJob |

### Response

Code | Description
--- | ---
200 CronJob | OK
201 CronJob | Created

# CrossVersionObjectReference v2beta1 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta1` | `CrossVersionObjectReference`

Other api versions of this object exist: v1

CrossVersionObjectReference contains enough information to let you identify the referred resource.

Appears In:

- HorizontalPodAutoscalerSpec autoscaling/v2beta1
- ObjectMetricSource autoscaling/v2beta1
- ObjectMetricStatus autoscaling/v2beta1

Field | Description
--- | ---
`apiVersion` string | API version of the referent
`kind` string | Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds&#34;
`name` string | Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names

# DaemonSet v1beta2 apps

Group | Version | Kind
--- | --- | ---
`apps` | `v1beta2` | `DaemonSet`

Other api versions of this object exist: v1 v1beta1

DEPRECATED - This group version of DaemonSet is deprecated by apps/v1/DaemonSet. See the release notes for more information. DaemonSet represents the configuration of a daemon set.

Appears In:

- DaemonSetList apps/v1beta2

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`spec` DaemonSetSpec | The desired behavior of this daemon set. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
`status` DaemonSetStatus | 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

### DaemonSetSpec v1beta2 apps

Appears In:

- DaemonSet apps/v1beta2

Field | Description
--- | ---
`minReadySeconds` integer | 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).
`revisionHistoryLimit` integer | 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.
`selector` LabelSelector | 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
`template` PodTemplateSpec | 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
`updateStrategy` DaemonSetUpdateStrategy | An update strategy to replace existing DaemonSet pods with new pods.

### DaemonSetStatus v1beta2 apps

Appears In:

- DaemonSet apps/v1beta2

Field | Description
--- | ---
`collisionCount` integer | 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.
`conditions` DaemonSetCondition array patch type: merge patch merge key: type | Represents the latest available observations of a DaemonSet's current state.
`currentNumberScheduled` integer | 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/
`desiredNumberScheduled` integer | 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/
`numberAvailable` integer | 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)
`numberMisscheduled` integer | 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/
`numberReady` integer | The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready.
`numberUnavailable` integer | 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)
`observedGeneration` integer | The most recent generation observed by the daemon set controller.
`updatedNumberScheduled` integer | The total number of nodes that are running updated daemon pod

### DaemonSetList v1beta2 apps

Field | Description
--- | ---
`apiVersion` string | 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
`items` DaemonSet array | A list of daemon sets.
`kind` string | 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
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

### RollingUpdateDaemonSet v1beta2 apps

Appears In:

- DaemonSetUpdateStrategy apps/v1beta2

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.

## Write Operations

See supported operations below...

## Create

> `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

> Output

    daemonset "daemonset-example" created

> Response Body

    {
      "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

### HTTP Request

`POST /apis/apps/v1beta2/namespaces/{namespace}/daemonsets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` DaemonSet |

### Response

Code | Description
--- | ---
200 DaemonSet | OK
201 DaemonSet | Created
202 DaemonSet | Accepted

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified DaemonSet

### HTTP Request

`PATCH /apis/apps/v1beta2/namespaces/{namespace}/daemonsets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the DaemonSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 DaemonSet | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified DaemonSet

### HTTP Request

`PUT /apis/apps/v1beta2/namespaces/{namespace}/daemonsets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the DaemonSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` DaemonSet |

### Response

Code | Description
--- | ---
201 DaemonSet | Created
200 DaemonSet | OK

## Delete

> `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'

> Output

    daemonset "daemonset-example" deleted

> Response Body

    {
      "kind": "Status",
      "apiVersion": "v1",
      "metadata": {},
      "status": "Success",
      "code": 200
    }

delete a DaemonSet

### HTTP Request

`DELETE /apis/apps/v1beta2/namespaces/{namespace}/daemonsets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the DaemonSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of DaemonSet

### HTTP Request

`DELETE /apis/apps/v1beta2/namespaces/{namespace}/daemonsets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `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

> Output

> Response Body

read the specified DaemonSet

### HTTP Request

`GET /apis/apps/v1beta2/namespaces/{namespace}/daemonsets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the DaemonSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Response

Code | Description
--- | ---
200 DaemonSet | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind DaemonSet

### HTTP Request

`GET /apis/apps/v1beta2/namespaces/{namespace}/daemonsets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 DaemonSetList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind DaemonSet

### HTTP Request

`GET /apis/apps/v1beta2/daemonsets`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 DaemonSetList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind DaemonSet

### HTTP Request

`GET /apis/apps/v1beta2/watch/namespaces/{namespace}/daemonsets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the DaemonSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of DaemonSet

### HTTP Request

`GET /apis/apps/v1beta2/watch/namespaces/{namespace}/daemonsets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of DaemonSet

### HTTP Request

`GET /apis/apps/v1beta2/watch/daemonsets`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Status Operations

See supported operations below...

## Patch Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update status of the specified DaemonSet

### HTTP Request

`PATCH /apis/apps/v1beta2/namespaces/{namespace}/daemonsets/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the DaemonSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 DaemonSet | OK

## Read Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read status of the specified DaemonSet

### HTTP Request

`GET /apis/apps/v1beta2/namespaces/{namespace}/daemonsets/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the DaemonSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 DaemonSet | OK

## Replace Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace status of the specified DaemonSet

### HTTP Request

`PUT /apis/apps/v1beta2/namespaces/{namespace}/daemonsets/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the DaemonSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` DaemonSet |

### Response

Code | Description
--- | ---
201 DaemonSet | Created
200 DaemonSet | OK

# DaemonSet v1beta1 extensions

Group | Version | Kind
--- | --- | ---
`extensions` | `v1beta1` | `DaemonSet`

Other api versions of this object exist: v1 v1beta2

DEPRECATED - This group version of DaemonSet is deprecated by apps/v1beta2/DaemonSet. See the release notes for more information. DaemonSet represents the configuration of a daemon set.

Appears In:

- DaemonSetList extensions/v1beta1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`spec` DaemonSetSpec | The desired behavior of this daemon set. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
`status` DaemonSetStatus | 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

### DaemonSetSpec v1beta1 extensions

Appears In:

- DaemonSet extensions/v1beta1

Field | Description
--- | ---
`minReadySeconds` integer | 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).
`revisionHistoryLimit` integer | 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.
`selector` LabelSelector | 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
`template` PodTemplateSpec | 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
`templateGeneration` integer | DEPRECATED. A sequence number representing a specific generation of the template. Populated by the system. It can be set only during the creation.
`updateStrategy` DaemonSetUpdateStrategy | An update strategy to replace existing DaemonSet pods with new pods.

### DaemonSetStatus v1beta1 extensions

Appears In:

- DaemonSet extensions/v1beta1

Field | Description
--- | ---
`collisionCount` integer | 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.
`conditions` DaemonSetCondition array patch type: merge patch merge key: type | Represents the latest available observations of a DaemonSet's current state.
`currentNumberScheduled` integer | 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/
`desiredNumberScheduled` integer | 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/
`numberAvailable` integer | 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)
`numberMisscheduled` integer | 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/
`numberReady` integer | The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready.
`numberUnavailable` integer | 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)
`observedGeneration` integer | The most recent generation observed by the daemon set controller.
`updatedNumberScheduled` integer | The total number of nodes that are running updated daemon pod

### DaemonSetList v1beta1 extensions

Field | Description
--- | ---
`apiVersion` string | 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
`items` DaemonSet array | A list of daemon sets.
`kind` string | 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
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

### RollingUpdateDaemonSet v1beta1 extensions

Appears In:

- DaemonSetUpdateStrategy extensions/v1beta1

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.

## Write Operations

See supported operations below...

## Create

> `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

> Output

    daemonset "daemonset-example" created

> Response Body

    {
      "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

### HTTP Request

`POST /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` DaemonSet |

### Response

Code | Description
--- | ---
202 DaemonSet | Accepted
200 DaemonSet | OK
201 DaemonSet | Created

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified DaemonSet

### HTTP Request

`PATCH /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the DaemonSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 DaemonSet | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified DaemonSet

### HTTP Request

`PUT /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the DaemonSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` DaemonSet |

### Response

Code | Description
--- | ---
200 DaemonSet | OK
201 DaemonSet | Created

## Delete

> `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'

> Output

    daemonset "daemonset-example" deleted

> Response Body

    {
      "kind": "Status",
      "apiVersion": "v1",
      "metadata": {},
      "status": "Success",
      "code": 200
    }

delete a DaemonSet

### HTTP Request

`DELETE /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the DaemonSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of DaemonSet

### HTTP Request

`DELETE /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `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

> Output

> Response Body

read the specified DaemonSet

### HTTP Request

`GET /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the DaemonSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Response

Code | Description
--- | ---
200 DaemonSet | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind DaemonSet

### HTTP Request

`GET /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 DaemonSetList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind DaemonSet

### HTTP Request

`GET /apis/extensions/v1beta1/daemonsets`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 DaemonSetList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind DaemonSet

### HTTP Request

`GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/daemonsets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the DaemonSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of DaemonSet

### HTTP Request

`GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/daemonsets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of DaemonSet

### HTTP Request

`GET /apis/extensions/v1beta1/watch/daemonsets`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Status Operations

See supported operations below...

## Patch Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update status of the specified DaemonSet

### HTTP Request

`PATCH /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the DaemonSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 DaemonSet | OK

## Read Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read status of the specified DaemonSet

### HTTP Request

`GET /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the DaemonSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 DaemonSet | OK

## Replace Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace status of the specified DaemonSet

### HTTP Request

`PUT /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the DaemonSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` DaemonSet |

### Response

Code | Description
--- | ---
200 DaemonSet | OK
201 DaemonSet | Created

# DaemonSetCondition v1beta2 apps

Group | Version | Kind
--- | --- | ---
`apps` | `v1beta2` | `DaemonSetCondition`

Other api versions of this object exist: v1 v1beta1

DaemonSetCondition describes the state of a DaemonSet at a certain point.

Appears In:

- DaemonSetStatus apps/v1beta2

Field | Description
--- | ---
`lastTransitionTime` Time | Last time the condition transitioned from one status to another.
`message` string | A human readable message indicating details about the transition.
`reason` string | The reason for the condition's last transition.
`status` string | Status of the condition, one of True, False, Unknown.
`type` string | Type of DaemonSet condition.

# DaemonSetCondition v1beta1 extensions

Group | Version | Kind
--- | --- | ---
`extensions` | `v1beta1` | `DaemonSetCondition`

Other api versions of this object exist: v1 v1beta2

DaemonSetCondition describes the state of a DaemonSet at a certain point.

Appears In:

- DaemonSetStatus extensions/v1beta1

Field | Description
--- | ---
`lastTransitionTime` Time | Last time the condition transitioned from one status to another.
`message` string | A human readable message indicating details about the transition.
`reason` string | The reason for the condition's last transition.
`status` string | Status of the condition, one of True, False, Unknown.
`type` string | Type of DaemonSet condition.

# DaemonSetUpdateStrategy v1beta2 apps

Group | Version | Kind
--- | --- | ---
`apps` | `v1beta2` | `DaemonSetUpdateStrategy`

Other api versions of this object exist: v1 v1beta1

DaemonSetUpdateStrategy is a struct used to control the update strategy for a DaemonSet.

Appears In:

- DaemonSetSpec apps/v1beta2

Field | Description
--- | ---
`rollingUpdate` RollingUpdateDaemonSet | Rolling update config params. Present only if type = "RollingUpdate".
`type` string | Type of daemon set update. Can be "RollingUpdate" or "OnDelete". Default is RollingUpdate.

# DaemonSetUpdateStrategy v1beta1 extensions

Group | Version | Kind
--- | --- | ---
`extensions` | `v1beta1` | `DaemonSetUpdateStrategy`

Other api versions of this object exist: v1 v1beta2
Appears In:

- DaemonSetSpec extensions/v1beta1

Field | Description
--- | ---
`rollingUpdate` RollingUpdateDaemonSet | Rolling update config params. Present only if type = "RollingUpdate".
`type` string | Type of daemon set update. Can be "RollingUpdate" or "OnDelete". Default is OnDelete.

# Deployment v1beta2 apps

Group | Version | Kind
--- | --- | ---
`apps` | `v1beta2` | `Deployment`

Other api versions of this object exist: v1 v1beta1 v1beta1

DEPRECATED - This group version of Deployment is deprecated by apps/v1/Deployment. See the release notes for more information. Deployment enables declarative updates for Pods and ReplicaSets.

Appears In:

- DeploymentList apps/v1beta2

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object metadata.
`spec` DeploymentSpec | Specification of the desired behavior of the Deployment.
`status` DeploymentStatus | Most recently observed status of the Deployment.

### DeploymentSpec v1beta2 apps

Appears In:

- Deployment apps/v1beta2

Field | Description
--- | ---
`minReadySeconds` integer | Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
`paused` boolean | Indicates that the deployment is paused.
`progressDeadlineSeconds` integer | The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s.
`replicas` integer | Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
`revisionHistoryLimit` integer | The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.
`selector` LabelSelector | 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.
`strategy` DeploymentStrategy | The deployment strategy to use to replace existing pods with new ones.
`template` PodTemplateSpec | Template describes the pods that will be created.

### DeploymentStatus v1beta2 apps

Appears In:

- Deployment apps/v1beta2

Field | Description
--- | ---
`availableReplicas` integer | Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.
`collisionCount` integer | Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet.
`conditions` DeploymentCondition array patch type: merge patch merge key: type | Represents the latest available observations of a deployment's current state.
`observedGeneration` integer | The generation observed by the deployment controller.
`readyReplicas` integer | Total number of ready pods targeted by this deployment.
`replicas` integer | Total number of non-terminated pods targeted by this deployment (their labels match the selector).
`unavailableReplicas` integer | Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created.
`updatedReplicas` integer | Total number of non-terminated pods targeted by this deployment that have the desired template spec.

### DeploymentList v1beta2 apps

Field | Description
--- | ---
`apiVersion` string | 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
`items` Deployment array | Items is the list of Deployments.
`kind` string | 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
`metadata` ListMeta | Standard list metadata.

### DeploymentStrategy v1beta2 apps

Appears In:

- DeploymentSpec apps/v1beta2

Field | Description
--- | ---
`rollingUpdate` RollingUpdateDeployment | Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate.
`type` string | Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.

### RollingUpdateDeployment v1beta2 apps

Appears In:

- DeploymentStrategy apps/v1beta2

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 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. Defaults to 25%. 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.

## Write Operations

See supported operations below...

## Create

> `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

> Output

    deployment "deployment-example" created

> Response Body

    {
      "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

### HTTP Request

`POST /apis/apps/v1beta2/namespaces/{namespace}/deployments`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Deployment |

### Response

Code | Description
--- | ---
201 Deployment | Created
202 Deployment | Accepted
200 Deployment | OK

## Patch

> `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'

> Output

    "deployment-example" patched

> Response Body

    {
      "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

### HTTP Request

`PATCH /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Deployment
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 Deployment | OK

## Replace

> `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

> Output

    deployment "deployment-example" replaced

> Response Body

    {
      "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

### HTTP Request

`PUT /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Deployment
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Deployment |

### Response

Code | Description
--- | ---
201 Deployment | Created
200 Deployment | OK

## Delete

> `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'

> Output

    deployment "deployment-example" deleted

> Response Body

    {
      "kind": "Status",
      "apiVersion": "v1",
      "metadata": {},
      "status": "Success",
      "code": 200
    }

delete a Deployment

### HTTP Request

`DELETE /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Deployment
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of Deployment

### HTTP Request

`DELETE /apis/apps/v1beta2/namespaces/{namespace}/deployments`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    $ kubectl get deployment deployment-example -o json

> `curl` Command (requires `kubectl proxy` to be running)

    $ kubectl proxy
    $ curl -X GET http://127.0.0.1:8001/apis/apps/v1beta2/namespaces/default/deployments/deployment-example

> Output

    {
      "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
      }
    }

> Response Body

    {
      "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

### HTTP Request

`GET /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Deployment
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`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.

### Response

Code | Description
--- | ---
200 Deployment | OK

## List

> `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'

> Output

    {
      "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
          }
        }
      ]
    }

> Response Body

    {
      "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

### HTTP Request

`GET /apis/apps/v1beta2/namespaces/{namespace}/deployments`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 DeploymentList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind Deployment

### HTTP Request

`GET /apis/apps/v1beta2/deployments`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 DeploymentList | OK

## Watch

> `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'

> Output

    {
        "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
            }
        }
    }

> Response Body

    {
        "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

### HTTP Request

`GET /apis/apps/v1beta2/watch/namespaces/{namespace}/deployments/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Deployment
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of Deployment

### HTTP Request

`GET /apis/apps/v1beta2/watch/namespaces/{namespace}/deployments`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of Deployment

### HTTP Request

`GET /apis/apps/v1beta2/watch/deployments`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Status Operations

See supported operations below...

## Patch Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update status of the specified Deployment

### HTTP Request

`PATCH /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Deployment
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 Deployment | OK

## Read Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read status of the specified Deployment

### HTTP Request

`GET /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Deployment
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 Deployment | OK

## Replace Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace status of the specified Deployment

### HTTP Request

`PUT /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Deployment
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Deployment |

### Response

Code | Description
--- | ---
200 Deployment | OK
201 Deployment | Created

## Misc Operations

See supported operations below...

## Read Scale

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read scale of the specified Deployment

### HTTP Request

`GET /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}/scale`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Scale
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 Scale | OK

## Replace Scale

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace scale of the specified Deployment

### HTTP Request

`PUT /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}/scale`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Scale
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Scale |

### Response

Code | Description
--- | ---
201 Scale | Created
200 Scale | OK

## Patch Scale

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update scale of the specified Deployment

### HTTP Request

`PATCH /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}/scale`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Scale
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 Scale | OK

# Deployment v1beta1 apps

Group | Version | Kind
--- | --- | ---
`apps` | `v1beta1` | `Deployment`

Other api versions of this object exist: v1 v1beta2

DEPRECATED - This group version of Deployment is deprecated by apps/v1beta2/Deployment. See the release notes for more information. Deployment enables declarative updates for Pods and ReplicaSets.

Appears In:

- DeploymentList apps/v1beta1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object metadata.
`spec` DeploymentSpec | Specification of the desired behavior of the Deployment.
`status` DeploymentStatus | Most recently observed status of the Deployment.

### DeploymentSpec v1beta1 apps

Appears In:

- Deployment apps/v1beta1

Field | Description
--- | ---
`minReadySeconds` integer | Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
`paused` boolean | Indicates that the deployment is paused.
`progressDeadlineSeconds` integer | The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s.
`replicas` integer | Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
`revisionHistoryLimit` integer | The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 2.
`rollbackTo` RollbackConfig | DEPRECATED. The config this deployment is rolling back to. Will be cleared after rollback is done.
`selector` LabelSelector | Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment.
`strategy` DeploymentStrategy | The deployment strategy to use to replace existing pods with new ones.
`template` PodTemplateSpec | Template describes the pods that will be created.

### DeploymentStatus v1beta1 apps

Appears In:

- Deployment apps/v1beta1

Field | Description
--- | ---
`availableReplicas` integer | Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.
`collisionCount` integer | Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet.
`conditions` DeploymentCondition array patch type: merge patch merge key: type | Represents the latest available observations of a deployment's current state.
`observedGeneration` integer | The generation observed by the deployment controller.
`readyReplicas` integer | Total number of ready pods targeted by this deployment.
`replicas` integer | Total number of non-terminated pods targeted by this deployment (their labels match the selector).
`unavailableReplicas` integer | Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created.
`updatedReplicas` integer | Total number of non-terminated pods targeted by this deployment that have the desired template spec.

### DeploymentList v1beta1 apps

Field | Description
--- | ---
`apiVersion` string | 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
`items` Deployment array | Items is the list of Deployments.
`kind` string | 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
`metadata` ListMeta | Standard list metadata.

### DeploymentStrategy v1beta1 apps

Appears In:

- DeploymentSpec apps/v1beta1

Field | Description
--- | ---
`rollingUpdate` RollingUpdateDeployment | Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate.
`type` string | Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.

### DeploymentRollback v1beta1 apps

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`name` string | Required: This must match the Name of a deployment.
`rollbackTo` RollbackConfig | The config of this deployment rollback.
`updatedAnnotations` object | The annotations to be updated to a deployment

### RollingUpdateDeployment v1beta1 apps

Appears In:

- DeploymentStrategy apps/v1beta1

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 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. Defaults to 25%. 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.

## Write Operations

See supported operations below...

## Create

> `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

> Output

    deployment "deployment-example" created

> Response Body

    {
      "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

### HTTP Request

`POST /apis/apps/v1beta1/namespaces/{namespace}/deployments`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Deployment |

### Response

Code | Description
--- | ---
200 Deployment | OK
201 Deployment | Created
202 Deployment | Accepted

## Patch

> `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'

> Output

    "deployment-example" patched

> Response Body

    {
      "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

### HTTP Request

`PATCH /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Deployment
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 Deployment | OK

## Replace

> `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

> Output

    deployment "deployment-example" replaced

> Response Body

    {
      "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

### HTTP Request

`PUT /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Deployment
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Deployment |

### Response

Code | Description
--- | ---
200 Deployment | OK
201 Deployment | Created

## Delete

> `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'

> Output

    deployment "deployment-example" deleted

> Response Body

    {
      "kind": "Status",
      "apiVersion": "v1",
      "metadata": {},
      "status": "Success",
      "code": 200
    }

delete a Deployment

### HTTP Request

`DELETE /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Deployment
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of Deployment

### HTTP Request

`DELETE /apis/apps/v1beta1/namespaces/{namespace}/deployments`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    $ kubectl get deployment deployment-example -o json

> `curl` Command (requires `kubectl proxy` to be running)

    $ kubectl proxy
    $ curl -X GET http://127.0.0.1:8001/apis/apps/v1beta1/namespaces/default/deployments/deployment-example

> Output

    {
      "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
      }
    }

> Response Body

    {
      "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

### HTTP Request

`GET /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Deployment
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`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.

### Response

Code | Description
--- | ---
200 Deployment | OK

## List

> `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'

> Output

    {
      "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
          }
        }
      ]
    }

> Response Body

    {
      "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

### HTTP Request

`GET /apis/apps/v1beta1/namespaces/{namespace}/deployments`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 DeploymentList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind Deployment

### HTTP Request

`GET /apis/apps/v1beta1/deployments`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 DeploymentList | OK

## Watch

> `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'

> Output

    {
        "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
            }
        }
    }

> Response Body

    {
        "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

### HTTP Request

`GET /apis/apps/v1beta1/watch/namespaces/{namespace}/deployments/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Deployment
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of Deployment

### HTTP Request

`GET /apis/apps/v1beta1/watch/namespaces/{namespace}/deployments`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of Deployment

### HTTP Request

`GET /apis/apps/v1beta1/watch/deployments`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Status Operations

See supported operations below...

## Patch Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update status of the specified Deployment

### HTTP Request

`PATCH /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Deployment
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 Deployment | OK

## Read Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read status of the specified Deployment

### HTTP Request

`GET /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Deployment
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 Deployment | OK

## Replace Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace status of the specified Deployment

### HTTP Request

`PUT /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Deployment
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Deployment |

### Response

Code | Description
--- | ---
200 Deployment | OK
201 Deployment | Created

## Misc Operations

See supported operations below...

## Read Scale

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read scale of the specified Deployment

### HTTP Request

`GET /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/scale`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Scale
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 Scale | OK

## Replace Scale

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace scale of the specified Deployment

### HTTP Request

`PUT /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/scale`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Scale
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Scale |

### Response

Code | Description
--- | ---
200 Scale | OK
201 Scale | Created

## Patch Scale

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update scale of the specified Deployment

### HTTP Request

`PATCH /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/scale`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Scale
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 Scale | OK

## Rollback

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create rollback of a Deployment

### HTTP Request

`POST /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/rollback`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the DeploymentRollback
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` DeploymentRollback |

### Response

Code | Description
--- | ---
200 DeploymentRollback | OK
201 DeploymentRollback | Created
202 DeploymentRollback | Accepted

# Deployment v1beta1 extensions

Group | Version | Kind
--- | --- | ---
`extensions` | `v1beta1` | `Deployment`

Other api versions of this object exist: v1 v1beta2

DEPRECATED - This group version of Deployment is deprecated by apps/v1beta2/Deployment. See the release notes for more information. Deployment enables declarative updates for Pods and ReplicaSets.

Appears In:

- DeploymentList extensions/v1beta1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object metadata.
`spec` DeploymentSpec | Specification of the desired behavior of the Deployment.
`status` DeploymentStatus | Most recently observed status of the Deployment.

### DeploymentSpec v1beta1 extensions

Appears In:

- Deployment extensions/v1beta1

Field | Description
--- | ---
`minReadySeconds` integer | Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
`paused` boolean | Indicates that the deployment is paused and will not be processed by the deployment controller.
`progressDeadlineSeconds` integer | The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. This is not set by default.
`replicas` integer | Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
`revisionHistoryLimit` integer | The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified.
`rollbackTo` RollbackConfig | DEPRECATED. The config this deployment is rolling back to. Will be cleared after rollback is done.
`selector` LabelSelector | Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment.
`strategy` DeploymentStrategy patch type: retainKeys | The deployment strategy to use to replace existing pods with new ones.
`template` PodTemplateSpec | Template describes the pods that will be created.

### DeploymentStatus v1beta1 extensions

Appears In:

- Deployment extensions/v1beta1

Field | Description
--- | ---
`availableReplicas` integer | Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.
`collisionCount` integer | Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet.
`conditions` DeploymentCondition array patch type: merge patch merge key: type | Represents the latest available observations of a deployment's current state.
`observedGeneration` integer | The generation observed by the deployment controller.
`readyReplicas` integer | Total number of ready pods targeted by this deployment.
`replicas` integer | Total number of non-terminated pods targeted by this deployment (their labels match the selector).
`unavailableReplicas` integer | Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created.
`updatedReplicas` integer | Total number of non-terminated pods targeted by this deployment that have the desired template spec.

### DeploymentList v1beta1 extensions

Field | Description
--- | ---
`apiVersion` string | 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
`items` Deployment array | Items is the list of Deployments.
`kind` string | 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
`metadata` ListMeta | Standard list metadata.

### DeploymentStrategy v1beta1 extensions

Appears In:

- DeploymentSpec extensions/v1beta1

Field | Description
--- | ---
`rollingUpdate` RollingUpdateDeployment | Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate.
`type` string | Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.

### DeploymentRollback v1beta1 extensions

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`name` string | Required: This must match the Name of a deployment.
`rollbackTo` RollbackConfig | The config of this deployment rollback.
`updatedAnnotations` object | The annotations to be updated to a deployment

### RollingUpdateDeployment v1beta1 extensions

Appears In:

- DeploymentStrategy extensions/v1beta1

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.

## Write Operations

See supported operations below...

## Create

> `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

> Output

    deployment "deployment-example" created

> Response Body

    {
      "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

### HTTP Request

`POST /apis/extensions/v1beta1/namespaces/{namespace}/deployments`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Deployment |

### Response

Code | Description
--- | ---
202 Deployment | Accepted
200 Deployment | OK
201 Deployment | Created

## Patch

> `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'

> Output

    "deployment-example" patched

> Response Body

    {
      "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

### HTTP Request

`PATCH /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Deployment
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 Deployment | OK

## Replace

> `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

> Output

    deployment "deployment-example" replaced

> Response Body

    {
      "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

### HTTP Request

`PUT /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Deployment
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Deployment |

### Response

Code | Description
--- | ---
201 Deployment | Created
200 Deployment | OK

## Delete

> `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'

> Output

    deployment "deployment-example" deleted

> Response Body

    {
      "kind": "Status",
      "apiVersion": "v1",
      "metadata": {},
      "status": "Success",
      "code": 200
    }

delete a Deployment

### HTTP Request

`DELETE /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Deployment
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of Deployment

### HTTP Request

`DELETE /apis/extensions/v1beta1/namespaces/{namespace}/deployments`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    $ kubectl get deployment deployment-example -o json

> `curl` Command (requires `kubectl proxy` to be running)

    $ kubectl proxy
    $ curl -X GET http://127.0.0.1:8001/apis/extensions/v1beta1/namespaces/default/deployments/deployment-example

> Output

    {
      "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
      }
    }

> Response Body

    {
      "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

### HTTP Request

`GET /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Deployment
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`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.

### Response

Code | Description
--- | ---
200 Deployment | OK

## List

> `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'

> Output

    {
      "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
          }
        }
      ]
    }

> Response Body

    {
      "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

### HTTP Request

`GET /apis/extensions/v1beta1/namespaces/{namespace}/deployments`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 DeploymentList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind Deployment

### HTTP Request

`GET /apis/extensions/v1beta1/deployments`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 DeploymentList | OK

## Watch

> `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'

> Output

    {
        "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
            }
        }
    }

> Response Body

    {
        "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

### HTTP Request

`GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/deployments/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Deployment
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of Deployment

### HTTP Request

`GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/deployments`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of Deployment

### HTTP Request

`GET /apis/extensions/v1beta1/watch/deployments`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Status Operations

See supported operations below...

## Patch Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update status of the specified Deployment

### HTTP Request

`PATCH /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Deployment
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 Deployment | OK

## Read Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read status of the specified Deployment

### HTTP Request

`GET /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Deployment
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 Deployment | OK

## Replace Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace status of the specified Deployment

### HTTP Request

`PUT /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Deployment
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Deployment |

### Response

Code | Description
--- | ---
201 Deployment | Created
200 Deployment | OK

## Misc Operations

See supported operations below...

## Read Scale

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read scale of the specified Deployment

### HTTP Request

`GET /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/scale`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Scale
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 Scale | OK

## Replace Scale

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace scale of the specified Deployment

### HTTP Request

`PUT /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/scale`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Scale
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Scale |

### Response

Code | Description
--- | ---
200 Scale | OK
201 Scale | Created

## Patch Scale

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update scale of the specified Deployment

### HTTP Request

`PATCH /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/scale`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Scale
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 Scale | OK

## Rollback

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create rollback of a Deployment

### HTTP Request

`POST /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/rollback`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the DeploymentRollback
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` DeploymentRollback |

### Response

Code | Description
--- | ---
200 DeploymentRollback | OK
201 DeploymentRollback | Created
202 DeploymentRollback | Accepted

# DeploymentCondition v1beta2 apps

Group | Version | Kind
--- | --- | ---
`apps` | `v1beta2` | `DeploymentCondition`

Other api versions of this object exist: v1 v1beta1 v1beta1

DeploymentCondition describes the state of a deployment at a certain point.

Appears In:

- DeploymentStatus apps/v1beta2

Field | Description
--- | ---
`lastTransitionTime` Time | Last time the condition transitioned from one status to another.
`lastUpdateTime` Time | The last time this condition was updated.
`message` string | A human readable message indicating details about the transition.
`reason` string | The reason for the condition's last transition.
`status` string | Status of the condition, one of True, False, Unknown.
`type` string | Type of deployment condition.

# DeploymentCondition v1beta1 apps

Group | Version | Kind
--- | --- | ---
`apps` | `v1beta1` | `DeploymentCondition`

Other api versions of this object exist: v1 v1beta2

DeploymentCondition describes the state of a deployment at a certain point.

Appears In:

- DeploymentStatus apps/v1beta1

Field | Description
--- | ---
`lastTransitionTime` Time | Last time the condition transitioned from one status to another.
`lastUpdateTime` Time | The last time this condition was updated.
`message` string | A human readable message indicating details about the transition.
`reason` string | The reason for the condition's last transition.
`status` string | Status of the condition, one of True, False, Unknown.
`type` string | Type of deployment condition.

# DeploymentCondition v1beta1 extensions

Group | Version | Kind
--- | --- | ---
`extensions` | `v1beta1` | `DeploymentCondition`

Other api versions of this object exist: v1 v1beta2

DeploymentCondition describes the state of a deployment at a certain point.

Appears In:

- DeploymentStatus extensions/v1beta1

Field | Description
--- | ---
`lastTransitionTime` Time | Last time the condition transitioned from one status to another.
`lastUpdateTime` Time | The last time this condition was updated.
`message` string | A human readable message indicating details about the transition.
`reason` string | The reason for the condition's last transition.
`status` string | Status of the condition, one of True, False, Unknown.
`type` string | Type of deployment condition.

# Event v1beta1 events.k8s.io

Group | Version | Kind
--- | --- | ---
`events.k8s.io` | `v1beta1` | `Event`

Other api versions of this object exist: v1

Event is a report of an event somewhere in the cluster. It generally denotes some state change in the system.

Appears In:

- EventList events/v1beta1

Field | Description
--- | ---
`action` string | What action was taken/failed regarding to the regarding object.
`apiVersion` string | 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
`deprecatedCount` integer | Deprecated field assuring backward compatibility with core.v1 Event type
`deprecatedFirstTimestamp` Time | Deprecated field assuring backward compatibility with core.v1 Event type
`deprecatedLastTimestamp` Time | Deprecated field assuring backward compatibility with core.v1 Event type
`deprecatedSource` EventSource | Deprecated field assuring backward compatibility with core.v1 Event type
`eventTime` MicroTime | Required. Time when this Event was first observed.
`kind` string | 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
`metadata` ObjectMeta |
`note` string | 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.
`reason` string | Why the action was taken.
`regarding` ObjectReference | 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.
`related` ObjectReference | Optional secondary object for more complex actions. E.g. when regarding object triggers a creation or deletion of related object.
`reportingController` string | Name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`.
`reportingInstance` string | ID of the controller instance, e.g. `kubelet-xyzf`.
`series` EventSeries | Data about the Event series this event represents or nil if it's a singleton Event.
`type` string | Type of this event (Normal, Warning), new types could be added in the future.

### EventList v1beta1 events

Field | Description
--- | ---
`apiVersion` string | 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
`items` Event array | Items is a list of schema objects.
`kind` string | 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
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create an Event

### HTTP Request

`POST /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Event |

### Response

Code | Description
--- | ---
200 Event | OK
201 Event | Created
202 Event | Accepted

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified Event

### HTTP Request

`PATCH /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Event
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 Event | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified Event

### HTTP Request

`PUT /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Event
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Event |

### Response

Code | Description
--- | ---
201 Event | Created
200 Event | OK

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete an Event

### HTTP Request

`DELETE /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Event
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of Event

### HTTP Request

`DELETE /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified Event

### HTTP Request

`GET /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Event
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

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.

### Response

Code | Description
--- | ---
200 Event | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind Event

### HTTP Request

`GET /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 EventList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind Event

### HTTP Request

`GET /apis/events.k8s.io/v1beta1/events`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 EventList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind Event

### HTTP Request

`GET /apis/events.k8s.io/v1beta1/watch/namespaces/{namespace}/events/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Event
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of Event

### HTTP Request

`GET /apis/events.k8s.io/v1beta1/watch/namespaces/{namespace}/events`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of Event

### HTTP Request

`GET /apis/events.k8s.io/v1beta1/watch/events`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

# EventSeries v1beta1 events.k8s.io

Group | Version | Kind
--- | --- | ---
`events.k8s.io` | `v1beta1` | `EventSeries`

Other api versions of this object exist: v1

EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time.

Appears In:

- Event events/v1beta1

Field | Description
--- | ---
`count` integer | Number of occurrences in this series up to the last heartbeat time
`lastObservedTime` MicroTime | Time when last Event from the series was seen before last heartbeat.
`state` string | Information whether this series is ongoing or finished.

# FSGroupStrategyOptions v1beta1 policy

Group | Version | Kind
--- | --- | ---
`policy` | `v1beta1` | `FSGroupStrategyOptions`

FSGroupStrategyOptions defines the strategy type and options used to create the strategy.

Appears In:

- PodSecurityPolicySpec policy/v1beta1

Field | Description
--- | ---
`ranges` IDRange 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.
`rule` string | Rule is the strategy that will dictate what FSGroup is used in the SecurityContext.

# HorizontalPodAutoscaler v2beta1 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta1` | `HorizontalPodAutoscaler`

Other api versions of this object exist: v1

HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler, which automatically manages the replica count of any resource implementing the scale subresource based on the metrics specified.

Appears In:

- HorizontalPodAutoscalerList autoscaling/v2beta1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`spec` HorizontalPodAutoscalerSpec | 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.
`status` HorizontalPodAutoscalerStatus | status is the current information about the autoscaler.

### HorizontalPodAutoscalerSpec v2beta1 autoscaling

Appears In:

- HorizontalPodAutoscaler autoscaling/v2beta1

Field | Description
--- | ---
`maxReplicas` integer | maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas.
`metrics` MetricSpec 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.
`minReplicas` integer | minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod.
`scaleTargetRef` CrossVersionObjectReference | 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.

### HorizontalPodAutoscalerStatus v2beta1 autoscaling

Appears In:

- HorizontalPodAutoscaler autoscaling/v2beta1

Field | Description
--- | ---
`conditions` HorizontalPodAutoscalerCondition array | conditions is the set of conditions required for this autoscaler to scale its target, and indicates whether or not those conditions are met.
`currentMetrics` MetricStatus array | currentMetrics is the last read state of the metrics used by this autoscaler.
`currentReplicas` integer | currentReplicas is current number of replicas of pods managed by this autoscaler, as last seen by the autoscaler.
`desiredReplicas` integer | desiredReplicas is the desired number of replicas of pods managed by this autoscaler, as last calculated by the autoscaler.
`lastScaleTime` Time | lastScaleTime is the last time the HorizontalPodAutoscaler scaled the number of pods, used by the autoscaler to control how often the number of pods is changed.
`observedGeneration` integer | observedGeneration is the most recent generation observed by this autoscaler.

### HorizontalPodAutoscalerList v2beta1 autoscaling

Field | Description
--- | ---
`apiVersion` string | 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
`items` HorizontalPodAutoscaler array | items is the list of horizontal pod autoscaler objects.
`kind` string | 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
`metadata` ListMeta | metadata is the standard list metadata.

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a HorizontalPodAutoscaler

### HTTP Request

`POST /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` HorizontalPodAutoscaler |

### Response

Code | Description
--- | ---
200 HorizontalPodAutoscaler | OK
201 HorizontalPodAutoscaler | Created
202 HorizontalPodAutoscaler | Accepted

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified HorizontalPodAutoscaler

### HTTP Request

`PATCH /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the HorizontalPodAutoscaler
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 HorizontalPodAutoscaler | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified HorizontalPodAutoscaler

### HTTP Request

`PUT /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the HorizontalPodAutoscaler
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` HorizontalPodAutoscaler |

### Response

Code | Description
--- | ---
200 HorizontalPodAutoscaler | OK
201 HorizontalPodAutoscaler | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a HorizontalPodAutoscaler

### HTTP Request

`DELETE /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the HorizontalPodAutoscaler
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of HorizontalPodAutoscaler

### HTTP Request

`DELETE /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified HorizontalPodAutoscaler

### HTTP Request

`GET /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the HorizontalPodAutoscaler
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Response

Code | Description
--- | ---
200 HorizontalPodAutoscaler | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind HorizontalPodAutoscaler

### HTTP Request

`GET /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 HorizontalPodAutoscalerList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind HorizontalPodAutoscaler

### HTTP Request

`GET /apis/autoscaling/v2beta1/horizontalpodautoscalers`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 HorizontalPodAutoscalerList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind HorizontalPodAutoscaler

### HTTP Request

`GET /apis/autoscaling/v2beta1/watch/namespaces/{namespace}/horizontalpodautoscalers/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the HorizontalPodAutoscaler
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of HorizontalPodAutoscaler

### HTTP Request

`GET /apis/autoscaling/v2beta1/watch/namespaces/{namespace}/horizontalpodautoscalers`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of HorizontalPodAutoscaler

### HTTP Request

`GET /apis/autoscaling/v2beta1/watch/horizontalpodautoscalers`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Status Operations

See supported operations below...

## Patch Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update status of the specified HorizontalPodAutoscaler

### HTTP Request

`PATCH /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the HorizontalPodAutoscaler
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 HorizontalPodAutoscaler | OK

## Read Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read status of the specified HorizontalPodAutoscaler

### HTTP Request

`GET /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the HorizontalPodAutoscaler
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 HorizontalPodAutoscaler | OK

## Replace Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace status of the specified HorizontalPodAutoscaler

### HTTP Request

`PUT /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the HorizontalPodAutoscaler
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` HorizontalPodAutoscaler |

### Response

Code | Description
--- | ---
200 HorizontalPodAutoscaler | OK
201 HorizontalPodAutoscaler | Created

# HostPortRange v1beta1 policy

Group | Version | Kind
--- | --- | ---
`policy` | `v1beta1` | `HostPortRange`

Host Port Range 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.

Appears In:

- PodSecurityPolicySpec policy/v1beta1

Field | Description
--- | ---
`max` integer | max is the end of the range, inclusive.
`min` integer | min is the start of the range, inclusive.

# IDRange v1beta1 policy

Group | Version | Kind
--- | --- | ---
`policy` | `v1beta1` | `IDRange`

ID Range provides a min/max of an allowed range of IDs.

Appears In:

- FSGroupStrategyOptions policy/v1beta1
- RunAsUserStrategyOptions policy/v1beta1
- SupplementalGroupsStrategyOptions policy/v1beta1

Field | Description
--- | ---
`max` integer | Max is the end of the range, inclusive.
`min` integer | Min is the start of the range, inclusive.

# IPBlock v1beta1 extensions

Group | Version | Kind
--- | --- | ---
`extensions` | `v1beta1` | `IPBlock`

Other api versions of this object exist: v1

DEPRECATED 1.9 - This group version of IPBlock is deprecated by networking/v1/IPBlock. IPBlock describes a particular CIDR (Ex. "192.168.1.1/24") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.

Appears In:

- NetworkPolicyPeer extensions/v1beta1

Field | Description
--- | ---
`cidr` string | CIDR is a string representing the IP Block Valid examples are "192.168.1.1/24"
`except` string array | Except is a slice of CIDRs that should not be included within an IP Block Valid examples are "192.168.1.1/24" Except values will be rejected if they are outside the CIDR range

# Initializer v1alpha1 admissionregistration.k8s.io

Group | Version | Kind
--- | --- | ---
`admissionregistration.k8s.io` | `v1alpha1` | `Initializer`

Other api versions of this object exist: v1

Initializer describes the name and the failure policy of an initializer, and what resources it applies to.

Appears In:

- InitializerConfiguration admissionregistration/v1alpha1

Field | Description
--- | ---
`name` string | Name is the identifier of the initializer. It will be added to the object that needs to be initialized. Name should be fully qualified, e.g., alwayspullimages.kubernetes.io, where "alwayspullimages" is the name of the webhook, and kubernetes.io is the name of the organization. Required
`rules` Rule 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.

# JobTemplateSpec v2alpha1 batch

Group | Version | Kind
--- | --- | ---
`batch` | `v2alpha1` | `JobTemplateSpec`

Other api versions of this object exist: v1beta1

JobTemplateSpec describes the data a Job should have when created from a template

Appears In:

- CronJobSpec batch/v2alpha1

Field | Description
--- | ---
`metadata` ObjectMeta | Standard object's metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`spec` JobSpec | Specification of the desired behavior of the job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

# LocalSubjectAccessReview v1beta1 authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`authorization.k8s.io` | `v1beta1` | `LocalSubjectAccessReview`

Other api versions of this object exist: v1

LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace. Having a namespace scoped resource makes it much easier to grant namespace scoped policy that includes permissions checking.

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta |
`spec` SubjectAccessReviewSpec | 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.
`status` SubjectAccessReviewStatus | Status is filled in by the server and indicates whether the request is allowed or not

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a LocalSubjectAccessReview

### HTTP Request

`POST /apis/authorization.k8s.io/v1beta1/namespaces/{namespace}/localsubjectaccessreviews`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` LocalSubjectAccessReview |

### Response

Code | Description
--- | ---
200 LocalSubjectAccessReview | OK
201 LocalSubjectAccessReview | Created
202 LocalSubjectAccessReview | Accepted

# NetworkPolicy v1beta1 extensions

Group | Version | Kind
--- | --- | ---
`extensions` | `v1beta1` | `NetworkPolicy`

Other api versions of this object exist: v1

DEPRECATED 1.9 - This group version of NetworkPolicy is deprecated by networking/v1/NetworkPolicy. NetworkPolicy describes what network traffic is allowed for a set of Pods

Appears In:

- NetworkPolicyList extensions/v1beta1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`spec` NetworkPolicySpec | Specification of the desired behavior for this NetworkPolicy.

### NetworkPolicySpec v1beta1 extensions

Appears In:

- NetworkPolicy extensions/v1beta1

Field | Description
--- | ---
`egress` NetworkPolicyEgressRule 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
`ingress` NetworkPolicyIngressRule 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).
`podSelector` LabelSelector | Selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace.
`policyTypes` string array | List of rule types that the NetworkPolicy relates to. Valid options are Ingress, Egress, or Ingress,Egress. If this field is not specified, it will default based on the existence of Ingress or Egress rules; policies that contain an Egress section are assumed to affect Egress, and all policies (whether or not they contain an Ingress section) are assumed to affect Ingress. If you want to write an egress-only policy, you must explicitly specify policyTypes [ "Egress" ]. Likewise, if you want to write a policy that specifies that no egress is allowed, you must specify a policyTypes value that include "Egress" (since such a policy would not include an Egress section and would otherwise default to just [ "Ingress" ]). This field is beta-level in 1.8

### NetworkPolicyList v1beta1 extensions

Field | Description
--- | ---
`apiVersion` string | 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
`items` NetworkPolicy array | Items is a list of schema objects.
`kind` string | 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
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a NetworkPolicy

### HTTP Request

`POST /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` NetworkPolicy |

### Response

Code | Description
--- | ---
200 NetworkPolicy | OK
201 NetworkPolicy | Created
202 NetworkPolicy | Accepted

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified NetworkPolicy

### HTTP Request

`PATCH /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the NetworkPolicy
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 NetworkPolicy | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified NetworkPolicy

### HTTP Request

`PUT /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the NetworkPolicy
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` NetworkPolicy |

### Response

Code | Description
--- | ---
200 NetworkPolicy | OK
201 NetworkPolicy | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a NetworkPolicy

### HTTP Request

`DELETE /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the NetworkPolicy
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of NetworkPolicy

### HTTP Request

`DELETE /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified NetworkPolicy

### HTTP Request

`GET /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the NetworkPolicy
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Response

Code | Description
--- | ---
200 NetworkPolicy | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind NetworkPolicy

### HTTP Request

`GET /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 NetworkPolicyList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind NetworkPolicy

### HTTP Request

`GET /apis/extensions/v1beta1/networkpolicies`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 NetworkPolicyList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind NetworkPolicy

### HTTP Request

`GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/networkpolicies/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the NetworkPolicy
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of NetworkPolicy

### HTTP Request

`GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/networkpolicies`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of NetworkPolicy

### HTTP Request

`GET /apis/extensions/v1beta1/watch/networkpolicies`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

# NetworkPolicyEgressRule v1beta1 extensions

Group | Version | Kind
--- | --- | ---
`extensions` | `v1beta1` | `NetworkPolicyEgressRule`

Other api versions of this object exist: v1

DEPRECATED 1.9 - This group version of NetworkPolicyEgressRule is deprecated by networking/v1/NetworkPolicyEgressRule. NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. This type is beta-level in 1.8

Appears In:

- NetworkPolicySpec extensions/v1beta1

Field | Description
--- | ---
`ports` NetworkPolicyPort 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.
`to` NetworkPolicyPeer 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.

# NetworkPolicyIngressRule v1beta1 extensions

Group | Version | Kind
--- | --- | ---
`extensions` | `v1beta1` | `NetworkPolicyIngressRule`

Other api versions of this object exist: v1

DEPRECATED 1.9 - This group version of NetworkPolicyIngressRule is deprecated by networking/v1/NetworkPolicyIngressRule. This NetworkPolicyIngressRule matches traffic if and only if the traffic matches both ports AND from.

Appears In:

- NetworkPolicySpec extensions/v1beta1

Field | Description
--- | ---
`from` NetworkPolicyPeer 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.
`ports` NetworkPolicyPort 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.

# NetworkPolicyPeer v1beta1 extensions

Group | Version | Kind
--- | --- | ---
`extensions` | `v1beta1` | `NetworkPolicyPeer`

Other api versions of this object exist: v1

DEPRECATED 1.9 - This group version of NetworkPolicyPeer is deprecated by networking/v1/NetworkPolicyPeer.

Appears In:

- NetworkPolicyEgressRule extensions/v1beta1
- NetworkPolicyIngressRule extensions/v1beta1

Field | Description
--- | ---
`ipBlock` IPBlock | IPBlock defines policy on a particular IPBlock
`namespaceSelector` LabelSelector | Selects Namespaces using cluster scoped-labels. This matches all pods in all namespaces selected by this label selector. This field follows standard label selector semantics. If present but empty, this selector selects all namespaces.
`podSelector` LabelSelector | This is a label selector which selects Pods in this namespace. This field follows standard label selector semantics. If present but empty, this selector selects all pods in this namespace.

# NetworkPolicyPort v1beta1 extensions

Group | Version | Kind
--- | --- | ---
`extensions` | `v1beta1` | `NetworkPolicyPort`

Other api versions of this object exist: v1

DEPRECATED 1.9 - This group version of NetworkPolicyPort is deprecated by networking/v1/NetworkPolicyPort.

Appears In:

- NetworkPolicyEgressRule extensions/v1beta1
- NetworkPolicyIngressRule extensions/v1beta1

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.
`protocol` string | Optional. The protocol (TCP or UDP) which traffic must match. If not specified, this field defaults to TCP.

# NonResourceAttributes v1beta1 authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`authorization.k8s.io` | `v1beta1` | `NonResourceAttributes`

Other api versions of this object exist: v1

NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface

Appears In:

- SelfSubjectAccessReviewSpec authorization/v1beta1
- SubjectAccessReviewSpec authorization/v1beta1

Field | Description
--- | ---
`path` string | Path is the URL path of the request
`verb` string | Verb is the standard HTTP verb

# NonResourceRule v1beta1 authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`authorization.k8s.io` | `v1beta1` | `NonResourceRule`

Other api versions of this object exist: v1

NonResourceRule holds information that describes a rule for the non-resource

Appears In:

- SubjectRulesReviewStatus authorization/v1beta1

Field | Description
--- | ---
`nonResourceURLs` string array | NonResourceURLs is a set of partial urls that a user should have access to. s are allowed, but only as the full, final step in the path. "" means all.
`verbs` string array | Verb is a list of kubernetes non-resource API verbs, like: get, post, put, delete, patch, head, options. "*" means all.

# PodSecurityPolicy v1beta1 policy

Group | Version | Kind
--- | --- | ---
`policy` | `v1beta1` | `PodSecurityPolicy`

Pod Security Policy governs the ability to make requests that affect the Security Context that will be applied to a pod and container.

Appears In:

- PodSecurityPolicyList policy/v1beta1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`spec` PodSecurityPolicySpec | spec defines the policy enforced.

### PodSecurityPolicySpec v1beta1 policy

Appears In:

- PodSecurityPolicy policy/v1beta1

Field | Description
--- | ---
`allowPrivilegeEscalation` boolean | AllowPrivilegeEscalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true.
`allowedCapabilities` string array | AllowedCapabilities is a list of capabilities that can be requested to add to the container. Capabilities in this field may be added at the pod author's discretion. You must not list a capability in both AllowedCapabilities and RequiredDropCapabilities.
`allowedFlexVolumes` AllowedFlexVolume 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.
`allowedHostPaths` AllowedHostPath array | is a white list of allowed host paths. Empty indicates that all host paths may be used.
`defaultAddCapabilities` string array | DefaultAddCapabilities is the default set of capabilities that will be added to the container unless the pod spec specifically drops the capability. You may not list a capability in both DefaultAddCapabilities and RequiredDropCapabilities. Capabilities added here are implicitly allowed, and need not be included in the AllowedCapabilities list.
`defaultAllowPrivilegeEscalation` boolean | DefaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process.
`fsGroup` FSGroupStrategyOptions | FSGroup is the strategy that will dictate what fs group is used by the SecurityContext.
`hostIPC` boolean | hostIPC determines if the policy allows the use of HostIPC in the pod spec.
`hostNetwork` boolean | hostNetwork determines if the policy allows the use of HostNetwork in the pod spec.
`hostPID` boolean | hostPID determines if the policy allows the use of HostPID in the pod spec.
`hostPorts` HostPortRange array | hostPorts determines which host port ranges are allowed to be exposed.
`privileged` boolean | privileged determines if a pod can request to be run as privileged.
`readOnlyRootFilesystem` boolean | ReadOnlyRootFilesystem when set to true will force containers to run with a read only root file system. If the container specifically requests to run with a non-read only root file system the PSP should deny the pod. If set to false the container may run with a read only root file system if it wishes but it will not be forced to.
`requiredDropCapabilities` string array | RequiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added.
`runAsUser` RunAsUserStrategyOptions | runAsUser is the strategy that will dictate the allowable RunAsUser values that may be set.
`seLinux` SELinuxStrategyOptions | seLinux is the strategy that will dictate the allowable labels that may be set.
`supplementalGroups` SupplementalGroupsStrategyOptions | SupplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext.
`volumes` string array | volumes is a white list of allowed volume plugins. Empty indicates that all plugins may be used.

### PodSecurityPolicyList v1beta1 policy

Field | Description
--- | ---
`apiVersion` string | 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
`items` PodSecurityPolicy array | Items is a list of schema objects.
`kind` string | 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
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a PodSecurityPolicy

### HTTP Request

`POST /apis/policy/v1beta1/podsecuritypolicies`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` PodSecurityPolicy |

### Response

Code | Description
--- | ---
202 PodSecurityPolicy | Accepted
200 PodSecurityPolicy | OK
201 PodSecurityPolicy | Created

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified PodSecurityPolicy

### HTTP Request

`PATCH /apis/policy/v1beta1/podsecuritypolicies/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PodSecurityPolicy

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 PodSecurityPolicy | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified PodSecurityPolicy

### HTTP Request

`PUT /apis/policy/v1beta1/podsecuritypolicies/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PodSecurityPolicy

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` PodSecurityPolicy |

### Response

Code | Description
--- | ---
201 PodSecurityPolicy | Created
200 PodSecurityPolicy | OK

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a PodSecurityPolicy

### HTTP Request

`DELETE /apis/policy/v1beta1/podsecuritypolicies/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PodSecurityPolicy

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of PodSecurityPolicy

### HTTP Request

`DELETE /apis/policy/v1beta1/podsecuritypolicies`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified PodSecurityPolicy

### HTTP Request

`GET /apis/policy/v1beta1/podsecuritypolicies/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PodSecurityPolicy

### Query Parameters

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.

### Response

Code | Description
--- | ---
200 PodSecurityPolicy | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind PodSecurityPolicy

### HTTP Request

`GET /apis/policy/v1beta1/podsecuritypolicies`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 PodSecurityPolicyList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind PodSecurityPolicy

### HTTP Request

`GET /apis/policy/v1beta1/watch/podsecuritypolicies/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PodSecurityPolicy

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of PodSecurityPolicy

### HTTP Request

`GET /apis/policy/v1beta1/watch/podsecuritypolicies`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

# PolicyRule v1beta1 rbac.authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`rbac.authorization.k8s.io` | `v1beta1` | `PolicyRule`

Other api versions of this object exist: v1 v1alpha1

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.

Appears In:

- ClusterRole rbac/v1beta1
- Role rbac/v1beta1

Field | Description
--- | ---
`apiGroups` string array | APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed.
`nonResourceURLs` string array | NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.
`resourceNames` string array | ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
`resources` string array | Resources is a list of resources this rule applies to. '*' represents all resources in the specified apiGroups. '*/foo' represents the subresource 'foo' for all resources in the specified apiGroups.
`verbs` string array | Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.

# PolicyRule v1alpha1 rbac.authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`rbac.authorization.k8s.io` | `v1alpha1` | `PolicyRule`

Other api versions of this object exist: v1 v1beta1

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.

Appears In:

- ClusterRole rbac/v1alpha1
- Role rbac/v1alpha1

Field | Description
--- | ---
`apiGroups` string array | APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed.
`nonResourceURLs` string array | NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path This name is intentionally different than the internal type so that the DefaultConvert works nicely and because the ordering may be different. Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.
`resourceNames` string array | ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
`resources` string array | Resources is a list of resources this rule applies to. ResourceAll represents all resources.
`verbs` string array | Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.

# ReplicaSet v1beta2 apps

Group | Version | Kind
--- | --- | ---
`apps` | `v1beta2` | `ReplicaSet`

Other api versions of this object exist: v1 v1beta1

DEPRECATED - This group version of ReplicaSet is deprecated by apps/v1/ReplicaSet. See the release notes for more information. ReplicaSet ensures that a specified number of pod replicas are running at any given time.

Appears In:

- ReplicaSetList apps/v1beta2

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | 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
`spec` ReplicaSetSpec | 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
`status` ReplicaSetStatus | 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

### ReplicaSetSpec v1beta2 apps

Appears In:

- ReplicaSet apps/v1beta2

Field | Description
--- | ---
`minReadySeconds` integer | Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
`replicas` integer | 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
`selector` LabelSelector | 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
`template` PodTemplateSpec | 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

### ReplicaSetStatus v1beta2 apps

Appears In:

- ReplicaSet apps/v1beta2

Field | Description
--- | ---
`availableReplicas` integer | The number of available replicas (ready for at least minReadySeconds) for this replica set.
`conditions` ReplicaSetCondition array patch type: merge patch merge key: type | Represents the latest available observations of a replica set's current state.
`fullyLabeledReplicas` integer | The number of pods that have labels matching the labels of the pod template of the replicaset.
`observedGeneration` integer | ObservedGeneration reflects the generation of the most recently observed ReplicaSet.
`readyReplicas` integer | The number of ready replicas for this replica set.
`replicas` integer | Replicas is the most recently oberved number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller

### ReplicaSetList v1beta2 apps

Field | Description
--- | ---
`apiVersion` string | 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
`items` ReplicaSet array | List of ReplicaSets. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller
`kind` string | 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
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a ReplicaSet

### HTTP Request

`POST /apis/apps/v1beta2/namespaces/{namespace}/replicasets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ReplicaSet |

### Response

Code | Description
--- | ---
200 ReplicaSet | OK
201 ReplicaSet | Created
202 ReplicaSet | Accepted

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified ReplicaSet

### HTTP Request

`PATCH /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ReplicaSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 ReplicaSet | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified ReplicaSet

### HTTP Request

`PUT /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ReplicaSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ReplicaSet |

### Response

Code | Description
--- | ---
200 ReplicaSet | OK
201 ReplicaSet | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a ReplicaSet

### HTTP Request

`DELETE /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ReplicaSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of ReplicaSet

### HTTP Request

`DELETE /apis/apps/v1beta2/namespaces/{namespace}/replicasets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified ReplicaSet

### HTTP Request

`GET /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ReplicaSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Response

Code | Description
--- | ---
200 ReplicaSet | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind ReplicaSet

### HTTP Request

`GET /apis/apps/v1beta2/namespaces/{namespace}/replicasets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 ReplicaSetList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind ReplicaSet

### HTTP Request

`GET /apis/apps/v1beta2/replicasets`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 ReplicaSetList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind ReplicaSet

### HTTP Request

`GET /apis/apps/v1beta2/watch/namespaces/{namespace}/replicasets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ReplicaSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of ReplicaSet

### HTTP Request

`GET /apis/apps/v1beta2/watch/namespaces/{namespace}/replicasets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of ReplicaSet

### HTTP Request

`GET /apis/apps/v1beta2/watch/replicasets`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Status Operations

See supported operations below...

## Patch Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update status of the specified ReplicaSet

### HTTP Request

`PATCH /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ReplicaSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 ReplicaSet | OK

## Read Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read status of the specified ReplicaSet

### HTTP Request

`GET /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ReplicaSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 ReplicaSet | OK

## Replace Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace status of the specified ReplicaSet

### HTTP Request

`PUT /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ReplicaSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ReplicaSet |

### Response

Code | Description
--- | ---
200 ReplicaSet | OK
201 ReplicaSet | Created

## Misc Operations

See supported operations below...

## Read Scale

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read scale of the specified ReplicaSet

### HTTP Request

`GET /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}/scale`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Scale
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 Scale | OK

## Replace Scale

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace scale of the specified ReplicaSet

### HTTP Request

`PUT /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}/scale`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Scale
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Scale |

### Response

Code | Description
--- | ---
200 Scale | OK
201 Scale | Created

## Patch Scale

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update scale of the specified ReplicaSet

### HTTP Request

`PATCH /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}/scale`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Scale
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 Scale | OK

# ReplicaSet v1beta1 extensions

Group | Version | Kind
--- | --- | ---
`extensions` | `v1beta1` | `ReplicaSet`

Other api versions of this object exist: v1 v1beta2

DEPRECATED - This group version of ReplicaSet is deprecated by apps/v1beta2/ReplicaSet. See the release notes for more information. ReplicaSet ensures that a specified number of pod replicas are running at any given time.

Appears In:

- ReplicaSetList extensions/v1beta1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | 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
`spec` ReplicaSetSpec | 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
`status` ReplicaSetStatus | 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

### ReplicaSetSpec v1beta1 extensions

Appears In:

- ReplicaSet extensions/v1beta1

Field | Description
--- | ---
`minReadySeconds` integer | Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
`replicas` integer | 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
`selector` LabelSelector | 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
`template` PodTemplateSpec | 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

### ReplicaSetStatus v1beta1 extensions

Appears In:

- ReplicaSet extensions/v1beta1

Field | Description
--- | ---
`availableReplicas` integer | The number of available replicas (ready for at least minReadySeconds) for this replica set.
`conditions` ReplicaSetCondition array patch type: merge patch merge key: type | Represents the latest available observations of a replica set's current state.
`fullyLabeledReplicas` integer | The number of pods that have labels matching the labels of the pod template of the replicaset.
`observedGeneration` integer | ObservedGeneration reflects the generation of the most recently observed ReplicaSet.
`readyReplicas` integer | The number of ready replicas for this replica set.
`replicas` integer | Replicas is the most recently oberved number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller

### ReplicaSetList v1beta1 extensions

Field | Description
--- | ---
`apiVersion` string | 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
`items` ReplicaSet array | List of ReplicaSets. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller
`kind` string | 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
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a ReplicaSet

### HTTP Request

`POST /apis/extensions/v1beta1/namespaces/{namespace}/replicasets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ReplicaSet |

### Response

Code | Description
--- | ---
200 ReplicaSet | OK
201 ReplicaSet | Created
202 ReplicaSet | Accepted

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified ReplicaSet

### HTTP Request

`PATCH /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ReplicaSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 ReplicaSet | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified ReplicaSet

### HTTP Request

`PUT /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ReplicaSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ReplicaSet |

### Response

Code | Description
--- | ---
200 ReplicaSet | OK
201 ReplicaSet | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a ReplicaSet

### HTTP Request

`DELETE /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ReplicaSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of ReplicaSet

### HTTP Request

`DELETE /apis/extensions/v1beta1/namespaces/{namespace}/replicasets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified ReplicaSet

### HTTP Request

`GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ReplicaSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Response

Code | Description
--- | ---
200 ReplicaSet | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind ReplicaSet

### HTTP Request

`GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 ReplicaSetList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind ReplicaSet

### HTTP Request

`GET /apis/extensions/v1beta1/replicasets`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 ReplicaSetList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind ReplicaSet

### HTTP Request

`GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/replicasets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ReplicaSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of ReplicaSet

### HTTP Request

`GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/replicasets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of ReplicaSet

### HTTP Request

`GET /apis/extensions/v1beta1/watch/replicasets`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Status Operations

See supported operations below...

## Patch Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update status of the specified ReplicaSet

### HTTP Request

`PATCH /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ReplicaSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 ReplicaSet | OK

## Read Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read status of the specified ReplicaSet

### HTTP Request

`GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ReplicaSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 ReplicaSet | OK

## Replace Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace status of the specified ReplicaSet

### HTTP Request

`PUT /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ReplicaSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` ReplicaSet |

### Response

Code | Description
--- | ---
201 ReplicaSet | Created
200 ReplicaSet | OK

## Misc Operations

See supported operations below...

## Read Scale

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read scale of the specified ReplicaSet

### HTTP Request

`GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/scale`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Scale
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 Scale | OK

## Replace Scale

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace scale of the specified ReplicaSet

### HTTP Request

`PUT /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/scale`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Scale
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Scale |

### Response

Code | Description
--- | ---
201 Scale | Created
200 Scale | OK

## Patch Scale

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update scale of the specified ReplicaSet

### HTTP Request

`PATCH /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/scale`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Scale
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 Scale | OK

# ReplicaSetCondition v1beta2 apps

Group | Version | Kind
--- | --- | ---
`apps` | `v1beta2` | `ReplicaSetCondition`

Other api versions of this object exist: v1 v1beta1

ReplicaSetCondition describes the state of a replica set at a certain point.

Appears In:

- ReplicaSetStatus apps/v1beta2

Field | Description
--- | ---
`lastTransitionTime` Time | The last time the condition transitioned from one status to another.
`message` string | A human readable message indicating details about the transition.
`reason` string | The reason for the condition's last transition.
`status` string | Status of the condition, one of True, False, Unknown.
`type` string | Type of replica set condition.

# ReplicaSetCondition v1beta1 extensions

Group | Version | Kind
--- | --- | ---
`extensions` | `v1beta1` | `ReplicaSetCondition`

Other api versions of this object exist: v1 v1beta2

ReplicaSetCondition describes the state of a replica set at a certain point.

Appears In:

- ReplicaSetStatus extensions/v1beta1

Field | Description
--- | ---
`lastTransitionTime` Time | The last time the condition transitioned from one status to another.
`message` string | A human readable message indicating details about the transition.
`reason` string | The reason for the condition's last transition.
`status` string | Status of the condition, one of True, False, Unknown.
`type` string | Type of replica set condition.

# ResourceAttributes v1beta1 authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`authorization.k8s.io` | `v1beta1` | `ResourceAttributes`

Other api versions of this object exist: v1

ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface

Appears In:

- SelfSubjectAccessReviewSpec authorization/v1beta1
- SubjectAccessReviewSpec authorization/v1beta1

Field | Description
--- | ---
`group` string | Group is the API Group of the Resource. "*" means all.
`name` string | Name is the name of the resource being requested for a "get" or deleted for a "delete". "" (empty) means all.
`namespace` string | Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces "" (empty) is defaulted for LocalSubjectAccessReviews "" (empty) is empty for cluster-scoped resources "" (empty) means "all" for namespace scoped resources from a SubjectAccessReview or SelfSubjectAccessReview
`resource` string | Resource is one of the existing resource types. "*" means all.
`subresource` string | Subresource is one of the existing resource types. "" means none.
`verb` string | Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all.
`version` string | Version is the API Version of the Resource. "*" means all.

# ResourceRule v1beta1 authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`authorization.k8s.io` | `v1beta1` | `ResourceRule`

Other api versions of this object exist: v1

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.

Appears In:

- SubjectRulesReviewStatus authorization/v1beta1

Field | Description
--- | ---
`apiGroups` string array | APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "*" means all.
`resourceNames` string array | ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. "*" means all.
`resources` string array | Resources is a list of resources this rule applies to. "" means all in the specified apiGroups. "/foo" represents the subresource 'foo' for all resources in the specified apiGroups.
`verbs` string array | Verb is a list of kubernetes resource API verbs, like: get, list, watch, create, update, delete, proxy. "*" means all.

# Role v1beta1 rbac.authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`rbac.authorization.k8s.io` | `v1beta1` | `Role`

Other api versions of this object exist: v1 v1alpha1

Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding.

Appears In:

- RoleList rbac/v1beta1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata.
`rules` PolicyRule array | Rules holds all the PolicyRules for this Role

### RoleList v1beta1 rbac

Field | Description
--- | ---
`apiVersion` string | 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
`items` Role array | Items is a list of Roles
`kind` string | 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
`metadata` ListMeta | Standard object's metadata.

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a Role

### HTTP Request

`POST /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Role |

### Response

Code | Description
--- | ---
202 Role | Accepted
200 Role | OK
201 Role | Created

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified Role

### HTTP Request

`PATCH /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Role
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 Role | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified Role

### HTTP Request

`PUT /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Role
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Role |

### Response

Code | Description
--- | ---
200 Role | OK
201 Role | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a Role

### HTTP Request

`DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Role
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of Role

### HTTP Request

`DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified Role

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Role
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 Role | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind Role

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 RoleList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind Role

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1beta1/roles`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 RoleList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind Role

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/roles/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Role
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of Role

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/roles`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of Role

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1beta1/watch/roles`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

# Role v1alpha1 rbac.authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`rbac.authorization.k8s.io` | `v1alpha1` | `Role`

Other api versions of this object exist: v1 v1beta1

Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding.

Appears In:

- RoleList rbac/v1alpha1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata.
`rules` PolicyRule array | Rules holds all the PolicyRules for this Role

### RoleList v1alpha1 rbac

Field | Description
--- | ---
`apiVersion` string | 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
`items` Role array | Items is a list of Roles
`kind` string | 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
`metadata` ListMeta | Standard object's metadata.

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a Role

### HTTP Request

`POST /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Role |

### Response

Code | Description
--- | ---
200 Role | OK
201 Role | Created
202 Role | Accepted

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified Role

### HTTP Request

`PATCH /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Role
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 Role | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified Role

### HTTP Request

`PUT /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Role
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Role |

### Response

Code | Description
--- | ---
200 Role | OK
201 Role | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a Role

### HTTP Request

`DELETE /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Role
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of Role

### HTTP Request

`DELETE /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified Role

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Role
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 Role | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind Role

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 RoleList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind Role

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1alpha1/roles`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 RoleList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind Role

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/roles/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Role
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of Role

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/roles`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of Role

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/roles`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

# RoleBinding v1beta1 rbac.authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`rbac.authorization.k8s.io` | `v1beta1` | `RoleBinding`

Other api versions of this object exist: v1 v1alpha1

RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace.

Appears In:

- RoleBindingList rbac/v1beta1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata.
`roleRef` RoleRef | 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.
`subjects` Subject array | Subjects holds references to the objects the role applies to.

### RoleBindingList v1beta1 rbac

Field | Description
--- | ---
`apiVersion` string | 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
`items` RoleBinding array | Items is a list of RoleBindings
`kind` string | 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
`metadata` ListMeta | Standard object's metadata.

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a RoleBinding

### HTTP Request

`POST /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` RoleBinding |

### Response

Code | Description
--- | ---
200 RoleBinding | OK
201 RoleBinding | Created
202 RoleBinding | Accepted

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified RoleBinding

### HTTP Request

`PATCH /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the RoleBinding
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 RoleBinding | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified RoleBinding

### HTTP Request

`PUT /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the RoleBinding
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` RoleBinding |

### Response

Code | Description
--- | ---
200 RoleBinding | OK
201 RoleBinding | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a RoleBinding

### HTTP Request

`DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the RoleBinding
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of RoleBinding

### HTTP Request

`DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified RoleBinding

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the RoleBinding
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 RoleBinding | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind RoleBinding

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 RoleBindingList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind RoleBinding

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1beta1/rolebindings`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 RoleBindingList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind RoleBinding

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/rolebindings/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the RoleBinding
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of RoleBinding

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/rolebindings`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of RoleBinding

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1beta1/watch/rolebindings`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

# RoleBinding v1alpha1 rbac.authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`rbac.authorization.k8s.io` | `v1alpha1` | `RoleBinding`

Other api versions of this object exist: v1 v1beta1

RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace.

Appears In:

- RoleBindingList rbac/v1alpha1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata.
`roleRef` RoleRef | 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.
`subjects` Subject array | Subjects holds references to the objects the role applies to.

### RoleBindingList v1alpha1 rbac

Field | Description
--- | ---
`apiVersion` string | 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
`items` RoleBinding array | Items is a list of RoleBindings
`kind` string | 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
`metadata` ListMeta | Standard object's metadata.

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a RoleBinding

### HTTP Request

`POST /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` RoleBinding |

### Response

Code | Description
--- | ---
202 RoleBinding | Accepted
200 RoleBinding | OK
201 RoleBinding | Created

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified RoleBinding

### HTTP Request

`PATCH /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the RoleBinding
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 RoleBinding | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified RoleBinding

### HTTP Request

`PUT /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the RoleBinding
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` RoleBinding |

### Response

Code | Description
--- | ---
201 RoleBinding | Created
200 RoleBinding | OK

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a RoleBinding

### HTTP Request

`DELETE /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the RoleBinding
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of RoleBinding

### HTTP Request

`DELETE /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified RoleBinding

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the RoleBinding
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 RoleBinding | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind RoleBinding

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 RoleBindingList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind RoleBinding

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1alpha1/rolebindings`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 RoleBindingList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind RoleBinding

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/rolebindings/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the RoleBinding
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of RoleBinding

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/rolebindings`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of RoleBinding

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/rolebindings`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

# RoleRef v1beta1 rbac.authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`rbac.authorization.k8s.io` | `v1beta1` | `RoleRef`

Other api versions of this object exist: v1 v1alpha1

RoleRef contains information that points to the role being used

Appears In:

- ClusterRoleBinding rbac/v1beta1
- RoleBinding rbac/v1beta1

Field | Description
--- | ---
`apiGroup` string | APIGroup is the group for the resource being referenced
`kind` string | Kind is the type of resource being referenced
`name` string | Name is the name of resource being referenced

# RoleRef v1alpha1 rbac.authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`rbac.authorization.k8s.io` | `v1alpha1` | `RoleRef`

Other api versions of this object exist: v1 v1beta1

RoleRef contains information that points to the role being used

Appears In:

- ClusterRoleBinding rbac/v1alpha1
- RoleBinding rbac/v1alpha1

Field | Description
--- | ---
`apiGroup` string | APIGroup is the group for the resource being referenced
`kind` string | Kind is the type of resource being referenced
`name` string | Name is the name of resource being referenced

# RollbackConfig v1beta1 extensions

Group | Version | Kind
--- | --- | ---
`extensions` | `v1beta1` | `RollbackConfig`

DEPRECATED.

Appears In:

- DeploymentRollback extensions/v1beta1
- DeploymentSpec extensions/v1beta1

Field | Description
--- | ---
`revision` integer | The revision to rollback to. If set to 0, rollback to the last revision.

# RollingUpdateStatefulSetStrategy v1beta2 apps

Group | Version | Kind
--- | --- | ---
`apps` | `v1beta2` | `RollingUpdateStatefulSetStrategy`

Other api versions of this object exist: v1 v1beta1

RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.

Appears In:

- StatefulSetUpdateStrategy apps/v1beta2

Field | Description
--- | ---
`partition` integer | Partition indicates the ordinal at which the StatefulSet should be partitioned. Default value is 0.

# RollingUpdateStatefulSetStrategy v1beta1 apps

Group | Version | Kind
--- | --- | ---
`apps` | `v1beta1` | `RollingUpdateStatefulSetStrategy`

Other api versions of this object exist: v1 v1beta2

RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.

Appears In:

- StatefulSetUpdateStrategy apps/v1beta1

Field | Description
--- | ---
`partition` integer | Partition indicates the ordinal at which the StatefulSet should be partitioned.

# RunAsUserStrategyOptions v1beta1 policy

Group | Version | Kind
--- | --- | ---
`policy` | `v1beta1` | `RunAsUserStrategyOptions`

Run A sUser Strategy Options defines the strategy type and any options used to create the strategy.

Appears In:

- PodSecurityPolicySpec policy/v1beta1

Field | Description
--- | ---
`ranges` IDRange array | Ranges are the allowed ranges of uids that may be used.
`rule` string | Rule is the strategy that will dictate the allowable RunAsUser values that may be set.

# SELinuxStrategyOptions v1beta1 policy

Group | Version | Kind
--- | --- | ---
`policy` | `v1beta1` | `SELinuxStrategyOptions`

SELinux Strategy Options defines the strategy type and any options used to create the strategy.

Appears In:

- PodSecurityPolicySpec policy/v1beta1

Field | Description
--- | ---
`rule` string | type is the strategy that will dictate the allowable labels that may be set.
`seLinuxOptions` SELinuxOptions | seLinuxOptions required to run as; required for MustRunAs More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

# Scale v1beta2 apps

Group | Version | Kind
--- | --- | ---
`apps` | `v1beta2` | `Scale`

Other api versions of this object exist: v1 v1beta1 v1beta1

Scale represents a scaling request for a resource.

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata.
`spec` ScaleSpec | defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status.
`status` ScaleStatus | current status of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. Read-only.

### ScaleSpec v1beta2 apps

Appears In:

- Scale apps/v1beta2

Field | Description
--- | ---
`replicas` integer | desired number of instances for the scaled object.

### ScaleStatus v1beta2 apps

Appears In:

- Scale apps/v1beta2

Field | Description
--- | ---
`replicas` integer | actual number of observed instances of the scaled object.
`selector` object | label query over pods that should match the replicas count. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
`targetSelector` string | label selector for pods that should match the replicas count. This is a serializated version of both map-based and more expressive set-based selectors. This is done to avoid introspection in the clients. The string will be in the same format as the query-param syntax. If the target type only supports map-based selectors, both this field and map-based selector field are populated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

# Scale v1beta1 apps

Group | Version | Kind
--- | --- | ---
`apps` | `v1beta1` | `Scale`

Other api versions of this object exist: v1 v1beta2

Scale represents a scaling request for a resource.

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata.
`spec` ScaleSpec | defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status.
`status` ScaleStatus | current status of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. Read-only.

### ScaleSpec v1beta1 apps

Appears In:

- Scale apps/v1beta1

Field | Description
--- | ---
`replicas` integer | desired number of instances for the scaled object.

### ScaleStatus v1beta1 apps

Appears In:

- Scale apps/v1beta1

Field | Description
--- | ---
`replicas` integer | actual number of observed instances of the scaled object.
`selector` object | label query over pods that should match the replicas count. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
`targetSelector` string | label selector for pods that should match the replicas count. This is a serializated version of both map-based and more expressive set-based selectors. This is done to avoid introspection in the clients. The string will be in the same format as the query-param syntax. If the target type only supports map-based selectors, both this field and map-based selector field are populated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

# Scale v1beta1 extensions

Group | Version | Kind
--- | --- | ---
`extensions` | `v1beta1` | `Scale`

Other api versions of this object exist: v1 v1beta2

represents a scaling request for a resource.

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata.
`spec` ScaleSpec | defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status.
`status` ScaleStatus | current status of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. Read-only.

### ScaleSpec v1beta1 extensions

Appears In:

- Scale extensions/v1beta1

Field | Description
--- | ---
`replicas` integer | desired number of instances for the scaled object.

### ScaleStatus v1beta1 extensions

Appears In:

- Scale extensions/v1beta1

Field | Description
--- | ---
`replicas` integer | actual number of observed instances of the scaled object.
`selector` object | label query over pods that should match the replicas count. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
`targetSelector` string | 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

# SelfSubjectAccessReview v1beta1 authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`authorization.k8s.io` | `v1beta1` | `SelfSubjectAccessReview`

Other api versions of this object exist: v1

SelfSubjectAccessReview checks whether or the current user can perform an action. Not filling in a spec.namespace means "in all namespaces". Self is a special case, because users should always be able to check whether they can perform an action

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta |
`spec` SelfSubjectAccessReviewSpec | Spec holds information about the request being evaluated. user and groups must be empty
`status` SubjectAccessReviewStatus | Status is filled in by the server and indicates whether the request is allowed or not

### SelfSubjectAccessReviewSpec v1beta1 authorization

Appears In:

- SelfSubjectAccessReview authorization/v1beta1

Field | Description
--- | ---
`nonResourceAttributes` NonResourceAttributes | NonResourceAttributes describes information for a non-resource access request
`resourceAttributes` ResourceAttributes | ResourceAuthorizationAttributes describes information for a resource access request

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a SelfSubjectAccessReview

### HTTP Request

`POST /apis/authorization.k8s.io/v1beta1/selfsubjectaccessreviews`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` SelfSubjectAccessReview |

### Response

Code | Description
--- | ---
202 SelfSubjectAccessReview | Accepted
200 SelfSubjectAccessReview | OK
201 SelfSubjectAccessReview | Created

# SelfSubjectRulesReview v1beta1 authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`authorization.k8s.io` | `v1beta1` | `SelfSubjectRulesReview`

Other api versions of this object exist: v1

SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace. The returned list of actions may be incomplete depending on the server's authorization mode, and any errors experienced during the evaluation. SelfSubjectRulesReview should be used by UIs to show/hide actions, or to quickly let an end user reason about their permissions. It should NOT Be used by external systems to drive authorization decisions as this raises confused deputy, cache lifetime/revocation, and correctness concerns. SubjectAccessReview, and LocalAccessReview are the correct way to defer authorization decisions to the API server.

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta |
`spec` SelfSubjectRulesReviewSpec | Spec holds information about the request being evaluated.
`status` SubjectRulesReviewStatus | Status is filled in by the server and indicates the set of actions a user can perform.

### SelfSubjectRulesReviewSpec v1beta1 authorization

Appears In:

- SelfSubjectRulesReview authorization/v1beta1

Field | Description
--- | ---
`namespace` string | Namespace to evaluate rules for. Required.

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a SelfSubjectRulesReview

### HTTP Request

`POST /apis/authorization.k8s.io/v1beta1/selfsubjectrulesreviews`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` SelfSubjectRulesReview |

### Response

Code | Description
--- | ---
202 SelfSubjectRulesReview | Accepted
200 SelfSubjectRulesReview | OK
201 SelfSubjectRulesReview | Created

# ServiceReference v1beta1 admissionregistration.k8s.io

Group | Version | Kind
--- | --- | ---
`admissionregistration.k8s.io` | `v1beta1` | `ServiceReference`

Other api versions of this object exist: v1

ServiceReference holds a reference to Service.legacy.k8s.io

Appears In:

- WebhookClientConfig admissionregistration/v1beta1

Field | Description
--- | ---
`name` string | `name` is the name of the service. Required
`namespace` string | `namespace` is the namespace of the service. Required
`path` string | `path` is an optional URL path which will be sent in any request to this service.

# ServiceReference v1beta1 apiregistration.k8s.io

Group | Version | Kind
--- | --- | ---
`apiregistration.k8s.io` | `v1beta1` | `ServiceReference`

Other api versions of this object exist: v1

ServiceReference holds a reference to Service.legacy.k8s.io

Appears In:

- APIServiceSpec apiregistration/v1beta1

Field | Description
--- | ---
`name` string | Name is the name of the service
`namespace` string | Namespace is the namespace of the service

# StatefulSet v1beta2 apps

Group | Version | Kind
--- | --- | ---
`apps` | `v1beta2` | `StatefulSet`

Other api versions of this object exist: v1 v1beta1

DEPRECATED - This group version of StatefulSet is deprecated by apps/v1/StatefulSet. See the release notes for more information. StatefulSet represents a set of pods with consistent identities. Identities are defined as:

- Network: A single stable DNS and hostname.
- Storage: As many VolumeClaims as requested. The StatefulSet guarantees that a given network identity will always map to the same storage identity.

Appears In:

- StatefulSetList apps/v1beta2

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta |
`spec` StatefulSetSpec | Spec defines the desired identities of pods in this set.
`status` StatefulSetStatus | Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time.

### StatefulSetSpec v1beta2 apps

Appears In:

- StatefulSet apps/v1beta2

Field | Description
--- | ---
`podManagementPolicy` string | podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is `OrderedReady`, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is `Parallel` which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.
`replicas` integer | replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.
`revisionHistoryLimit` integer | revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.
`selector` LabelSelector | 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
`serviceName` string | serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller.
`template` PodTemplateSpec | template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet.
`updateStrategy` StatefulSetUpdateStrategy | updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.
`volumeClaimTemplates` PersistentVolumeClaim 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.

### StatefulSetStatus v1beta2 apps

Appears In:

- StatefulSet apps/v1beta2

Field | Description
--- | ---
`collisionCount` integer | collisionCount is the count of hash collisions for the StatefulSet. The StatefulSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.
`conditions` StatefulSetCondition array patch type: merge patch merge key: type | Represents the latest available observations of a statefulset's current state.
`currentReplicas` integer | currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision.
`currentRevision` string | currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas).
`observedGeneration` integer | observedGeneration is the most recent generation observed for this StatefulSet. It corresponds to the StatefulSet's generation, which is updated on mutation by the API Server.
`readyReplicas` integer | readyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition.
`replicas` integer | replicas is the number of Pods created by the StatefulSet controller.
`updateRevision` string | updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [replicas-updatedReplicas,replicas)
`updatedReplicas` integer | updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision.

### StatefulSetList v1beta2 apps

Field | Description
--- | ---
`apiVersion` string | 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
`items` StatefulSet array |
`kind` string | 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
`metadata` ListMeta |

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a StatefulSet

### HTTP Request

`POST /apis/apps/v1beta2/namespaces/{namespace}/statefulsets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` StatefulSet |

### Response

Code | Description
--- | ---
201 StatefulSet | Created
202 StatefulSet | Accepted
200 StatefulSet | OK

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified StatefulSet

### HTTP Request

`PATCH /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StatefulSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 StatefulSet | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified StatefulSet

### HTTP Request

`PUT /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StatefulSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` StatefulSet |

### Response

Code | Description
--- | ---
200 StatefulSet | OK
201 StatefulSet | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a StatefulSet

### HTTP Request

`DELETE /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StatefulSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of StatefulSet

### HTTP Request

`DELETE /apis/apps/v1beta2/namespaces/{namespace}/statefulsets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified StatefulSet

### HTTP Request

`GET /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StatefulSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Response

Code | Description
--- | ---
200 StatefulSet | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind StatefulSet

### HTTP Request

`GET /apis/apps/v1beta2/namespaces/{namespace}/statefulsets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 StatefulSetList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind StatefulSet

### HTTP Request

`GET /apis/apps/v1beta2/statefulsets`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 StatefulSetList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind StatefulSet

### HTTP Request

`GET /apis/apps/v1beta2/watch/namespaces/{namespace}/statefulsets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StatefulSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of StatefulSet

### HTTP Request

`GET /apis/apps/v1beta2/watch/namespaces/{namespace}/statefulsets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of StatefulSet

### HTTP Request

`GET /apis/apps/v1beta2/watch/statefulsets`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Status Operations

See supported operations below...

## Patch Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update status of the specified StatefulSet

### HTTP Request

`PATCH /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StatefulSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 StatefulSet | OK

## Read Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read status of the specified StatefulSet

### HTTP Request

`GET /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StatefulSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 StatefulSet | OK

## Replace Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace status of the specified StatefulSet

### HTTP Request

`PUT /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StatefulSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` StatefulSet |

### Response

Code | Description
--- | ---
200 StatefulSet | OK
201 StatefulSet | Created

## Misc Operations

See supported operations below...

## Read Scale

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read scale of the specified StatefulSet

### HTTP Request

`GET /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}/scale`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Scale
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 Scale | OK

## Replace Scale

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace scale of the specified StatefulSet

### HTTP Request

`PUT /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}/scale`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Scale
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Scale |

### Response

Code | Description
--- | ---
201 Scale | Created
200 Scale | OK

## Patch Scale

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update scale of the specified StatefulSet

### HTTP Request

`PATCH /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}/scale`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Scale
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 Scale | OK

# StatefulSet v1beta1 apps

Group | Version | Kind
--- | --- | ---
`apps` | `v1beta1` | `StatefulSet`

Other api versions of this object exist: v1 v1beta2

DEPRECATED - This group version of StatefulSet is deprecated by apps/v1beta2/StatefulSet. See the release notes for more information. StatefulSet represents a set of pods with consistent identities. Identities are defined as:

- Network: A single stable DNS and hostname.
- Storage: As many VolumeClaims as requested. The StatefulSet guarantees that a given network identity will always map to the same storage identity.

Appears In:

- StatefulSetList apps/v1beta1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta |
`spec` StatefulSetSpec | Spec defines the desired identities of pods in this set.
`status` StatefulSetStatus | Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time.

### StatefulSetSpec v1beta1 apps

Appears In:

- StatefulSet apps/v1beta1

Field | Description
--- | ---
`podManagementPolicy` string | podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is `OrderedReady`, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is `Parallel` which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.
`replicas` integer | replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.
`revisionHistoryLimit` integer | revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.
`selector` LabelSelector | 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
`serviceName` string | serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller.
`template` PodTemplateSpec | template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet.
`updateStrategy` StatefulSetUpdateStrategy | updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.
`volumeClaimTemplates` PersistentVolumeClaim 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.

### StatefulSetStatus v1beta1 apps

Appears In:

- StatefulSet apps/v1beta1

Field | Description
--- | ---
`collisionCount` integer | collisionCount is the count of hash collisions for the StatefulSet. The StatefulSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.
`conditions` StatefulSetCondition array patch type: merge patch merge key: type | Represents the latest available observations of a statefulset's current state.
`currentReplicas` integer | currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision.
`currentRevision` string | currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas).
`observedGeneration` integer | observedGeneration is the most recent generation observed for this StatefulSet. It corresponds to the StatefulSet's generation, which is updated on mutation by the API Server.
`readyReplicas` integer | readyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition.
`replicas` integer | replicas is the number of Pods created by the StatefulSet controller.
`updateRevision` string | updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [replicas-updatedReplicas,replicas)
`updatedReplicas` integer | updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision.

### StatefulSetList v1beta1 apps

Field | Description
--- | ---
`apiVersion` string | 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
`items` StatefulSet array |
`kind` string | 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
`metadata` ListMeta |

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a StatefulSet

### HTTP Request

`POST /apis/apps/v1beta1/namespaces/{namespace}/statefulsets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` StatefulSet |

### Response

Code | Description
--- | ---
200 StatefulSet | OK
201 StatefulSet | Created
202 StatefulSet | Accepted

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified StatefulSet

### HTTP Request

`PATCH /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StatefulSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 StatefulSet | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified StatefulSet

### HTTP Request

`PUT /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StatefulSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` StatefulSet |

### Response

Code | Description
--- | ---
200 StatefulSet | OK
201 StatefulSet | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a StatefulSet

### HTTP Request

`DELETE /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StatefulSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of StatefulSet

### HTTP Request

`DELETE /apis/apps/v1beta1/namespaces/{namespace}/statefulsets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified StatefulSet

### HTTP Request

`GET /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StatefulSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`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.

### Response

Code | Description
--- | ---
200 StatefulSet | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind StatefulSet

### HTTP Request

`GET /apis/apps/v1beta1/namespaces/{namespace}/statefulsets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 StatefulSetList | OK

## List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind StatefulSet

### HTTP Request

`GET /apis/apps/v1beta1/statefulsets`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 StatefulSetList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind StatefulSet

### HTTP Request

`GET /apis/apps/v1beta1/watch/namespaces/{namespace}/statefulsets/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StatefulSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of StatefulSet

### HTTP Request

`GET /apis/apps/v1beta1/watch/namespaces/{namespace}/statefulsets`

### Path Parameters

Parameter | Description
--- | ---
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List All Namespaces

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of StatefulSet

### HTTP Request

`GET /apis/apps/v1beta1/watch/statefulsets`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Status Operations

See supported operations below...

## Patch Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update status of the specified StatefulSet

### HTTP Request

`PATCH /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StatefulSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 StatefulSet | OK

## Read Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read status of the specified StatefulSet

### HTTP Request

`GET /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StatefulSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 StatefulSet | OK

## Replace Status

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace status of the specified StatefulSet

### HTTP Request

`PUT /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StatefulSet
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` StatefulSet |

### Response

Code | Description
--- | ---
200 StatefulSet | OK
201 StatefulSet | Created

## Misc Operations

See supported operations below...

## Read Scale

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read scale of the specified StatefulSet

### HTTP Request

`GET /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/scale`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Scale
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Response

Code | Description
--- | ---
200 Scale | OK

## Replace Scale

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace scale of the specified StatefulSet

### HTTP Request

`PUT /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/scale`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Scale
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Scale |

### Response

Code | Description
--- | ---
200 Scale | OK
201 Scale | Created

## Patch Scale

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update scale of the specified StatefulSet

### HTTP Request

`PATCH /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/scale`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Scale
`namespace` | object name and auth scope, such as for teams and projects

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 Scale | OK

# StatefulSetCondition v1beta2 apps

Group | Version | Kind
--- | --- | ---
`apps` | `v1beta2` | `StatefulSetCondition`

Other api versions of this object exist: v1 v1beta1

StatefulSetCondition describes the state of a statefulset at a certain point.

Appears In:

- StatefulSetStatus apps/v1beta2

Field | Description
--- | ---
`lastTransitionTime` Time | Last time the condition transitioned from one status to another.
`message` string | A human readable message indicating details about the transition.
`reason` string | The reason for the condition's last transition.
`status` string | Status of the condition, one of True, False, Unknown.
`type` string | Type of statefulset condition.

# StatefulSetCondition v1beta1 apps

Group | Version | Kind
--- | --- | ---
`apps` | `v1beta1` | `StatefulSetCondition`

Other api versions of this object exist: v1 v1beta2

StatefulSetCondition describes the state of a statefulset at a certain point.

Appears In:

- StatefulSetStatus apps/v1beta1

Field | Description
--- | ---
`lastTransitionTime` Time | Last time the condition transitioned from one status to another.
`message` string | A human readable message indicating details about the transition.
`reason` string | The reason for the condition's last transition.
`status` string | Status of the condition, one of True, False, Unknown.
`type` string | Type of statefulset condition.

# StatefulSetUpdateStrategy v1beta2 apps

Group | Version | Kind
--- | --- | ---
`apps` | `v1beta2` | `StatefulSetUpdateStrategy`

Other api versions of this object exist: v1 v1beta1

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.

Appears In:

- StatefulSetSpec apps/v1beta2

Field | Description
--- | ---
`rollingUpdate` RollingUpdateStatefulSetStrategy | RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType.
`type` string | Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate.

# StatefulSetUpdateStrategy v1beta1 apps

Group | Version | Kind
--- | --- | ---
`apps` | `v1beta1` | `StatefulSetUpdateStrategy`

Other api versions of this object exist: v1 v1beta2

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.

Appears In:

- StatefulSetSpec apps/v1beta1

Field | Description
--- | ---
`rollingUpdate` RollingUpdateStatefulSetStrategy | RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType.
`type` string | Type indicates the type of the StatefulSetUpdateStrategy.

# StorageClass v1beta1 storage.k8s.io

Group | Version | Kind
--- | --- | ---
`storage.k8s.io` | `v1beta1` | `StorageClass`

Other api versions of this object exist: v1

StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned.

StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name.

Appears In:

- StorageClassList storage/v1beta1

Field | Description
--- | ---
`allowVolumeExpansion` boolean | AllowVolumeExpansion shows whether the storage class allow volume expand
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`mountOptions` string array | Dynamically provisioned PersistentVolumes of this storage class are created with these mountOptions, e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid.
`parameters` object | Parameters holds the parameters for the provisioner that should create volumes of this storage class.
`provisioner` string | Provisioner indicates the type of the provisioner.
`reclaimPolicy` string | Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. Defaults to Delete.
`volumeBindingMode` string | VolumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is alpha-level and is only honored by servers that enable the VolumeScheduling feature.

### StorageClassList v1beta1 storage

Field | Description
--- | ---
`apiVersion` string | 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
`items` StorageClass array | Items is the list of StorageClasses
`kind` string | 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
`metadata` ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a StorageClass

### HTTP Request

`POST /apis/storage.k8s.io/v1beta1/storageclasses`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` StorageClass |

### Response

Code | Description
--- | ---
202 StorageClass | Accepted
200 StorageClass | OK
201 StorageClass | Created

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified StorageClass

### HTTP Request

`PATCH /apis/storage.k8s.io/v1beta1/storageclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StorageClass

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 StorageClass | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified StorageClass

### HTTP Request

`PUT /apis/storage.k8s.io/v1beta1/storageclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StorageClass

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` StorageClass |

### Response

Code | Description
--- | ---
200 StorageClass | OK
201 StorageClass | Created

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a StorageClass

### HTTP Request

`DELETE /apis/storage.k8s.io/v1beta1/storageclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StorageClass

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of StorageClass

### HTTP Request

`DELETE /apis/storage.k8s.io/v1beta1/storageclasses`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified StorageClass

### HTTP Request

`GET /apis/storage.k8s.io/v1beta1/storageclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StorageClass

### Query Parameters

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.

### Response

Code | Description
--- | ---
200 StorageClass | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind StorageClass

### HTTP Request

`GET /apis/storage.k8s.io/v1beta1/storageclasses`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 StorageClassList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind StorageClass

### HTTP Request

`GET /apis/storage.k8s.io/v1beta1/watch/storageclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StorageClass

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of StorageClass

### HTTP Request

`GET /apis/storage.k8s.io/v1beta1/watch/storageclasses`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

# Subject v1beta1 rbac.authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`rbac.authorization.k8s.io` | `v1beta1` | `Subject`

Other api versions of this object exist: v1 v1alpha1

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.

Appears In:

- ClusterRoleBinding rbac/v1beta1
- RoleBinding rbac/v1beta1

Field | Description
--- | ---
`apiGroup` string | APIGroup holds the API group of the referenced subject. Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects.
`kind` string | Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error.
`name` string | Name of the object being referenced.
`namespace` string | Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error.

# Subject v1alpha1 rbac.authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`rbac.authorization.k8s.io` | `v1alpha1` | `Subject`

Other api versions of this object exist: v1 v1beta1

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.

Appears In:

- ClusterRoleBinding rbac/v1alpha1
- RoleBinding rbac/v1alpha1

Field | Description
--- | ---
`apiVersion` string | APIVersion holds the API group and version of the referenced subject. Defaults to "v1" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io/v1alpha1" for User and Group subjects.
`kind` string | Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error.
`name` string | Name of the object being referenced.
`namespace` string | Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error.

# SubjectAccessReview v1beta1 authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`authorization.k8s.io` | `v1beta1` | `SubjectAccessReview`

Other api versions of this object exist: v1

SubjectAccessReview checks whether or not a user or group can perform an action.

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta |
`spec` SubjectAccessReviewSpec | Spec holds information about the request being evaluated
`status` SubjectAccessReviewStatus | Status is filled in by the server and indicates whether the request is allowed or not

### SubjectAccessReviewSpec v1beta1 authorization

Appears In:

- LocalSubjectAccessReview authorization/v1beta1
- SubjectAccessReview authorization/v1beta1

Field | Description
--- | ---
`extra` object | Extra corresponds to the user.Info.GetExtra() method from the authenticator. Since that is input to the authorizer it needs a reflection here.
`group` string array | Groups is the groups you're testing for.
`nonResourceAttributes` NonResourceAttributes | NonResourceAttributes describes information for a non-resource access request
`resourceAttributes` ResourceAttributes | ResourceAuthorizationAttributes describes information for a resource access request
`uid` string | UID information about the requesting user.
`user` string | User is the user you're testing for. If you specify "User" but not "Group", then is it interpreted as "What if User were not a member of any groups

### SubjectAccessReviewStatus v1beta1 authorization

Appears In:

- LocalSubjectAccessReview authorization/v1beta1
- SelfSubjectAccessReview authorization/v1beta1
- SubjectAccessReview authorization/v1beta1

Field | Description
--- | ---
`allowed` boolean | Allowed is required. True if the action would be allowed, false otherwise.
`denied` boolean | Denied is optional. True if the action would be denied, otherwise false. If both allowed is false and denied is false, then the authorizer has no opinion on whether to authorize the action. Denied may not be true if Allowed is true.
`evaluationError` string | EvaluationError is an indication that some error occurred during the authorization check. It is entirely possible to get an error and be able to continue determine authorization status in spite of it. For instance, RBAC can be missing a role, but enough roles are still present and bound to reason about the request.
`reason` string | Reason is optional. It indicates why a request was allowed or denied.

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a SubjectAccessReview

### HTTP Request

`POST /apis/authorization.k8s.io/v1beta1/subjectaccessreviews`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` SubjectAccessReview |

### Response

Code | Description
--- | ---
200 SubjectAccessReview | OK
201 SubjectAccessReview | Created
202 SubjectAccessReview | Accepted

# SubjectRulesReviewStatus v1beta1 authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`authorization.k8s.io` | `v1beta1` | `SubjectRulesReviewStatus`

Other api versions of this object exist: v1

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.

Appears In:

- SelfSubjectRulesReview authorization/v1beta1

Field | Description
--- | ---
`evaluationError` string | EvaluationError can appear in combination with Rules. It indicates an error occurred during rule evaluation, such as an authorizer that doesn't support rule evaluation, and that ResourceRules and/or NonResourceRules may be incomplete.
`incomplete` boolean | Incomplete is true when the rules returned by this call are incomplete. This is most commonly encountered when an authorizer, such as an external authorizer, doesn't support rules evaluation.
`nonResourceRules` NonResourceRule 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.
`resourceRules` ResourceRule 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.

# SupplementalGroupsStrategyOptions v1beta1 policy

Group | Version | Kind
--- | --- | ---
`policy` | `v1beta1` | `SupplementalGroupsStrategyOptions`

SupplementalGroupsStrategyOptions defines the strategy type and options used to create the strategy.

Appears In:

- PodSecurityPolicySpec policy/v1beta1

Field | Description
--- | ---
`ranges` IDRange 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.
`rule` string | Rule is the strategy that will dictate what supplemental groups is used in the SecurityContext.

# TokenReview v1beta1 authentication.k8s.io

Group | Version | Kind
--- | --- | ---
`authentication.k8s.io` | `v1beta1` | `TokenReview`

Other api versions of this object exist: v1

TokenReview attempts to authenticate a token to a known user. Note: TokenReview requests may be cached by the webhook token authenticator plugin in the kube-apiserver.

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta |
`spec` TokenReviewSpec | Spec holds information about the request being evaluated
`status` TokenReviewStatus | Status is filled in by the server and indicates whether the request can be authenticated.

### TokenReviewSpec v1beta1 authentication

Appears In:

- TokenReview authentication/v1beta1

Field | Description
--- | ---
`token` string | Token is the opaque bearer token.

### TokenReviewStatus v1beta1 authentication

Appears In:

- TokenReview authentication/v1beta1

Field | Description
--- | ---
`authenticated` boolean | Authenticated indicates that the token was associated with a known user.
`error` string | Error indicates that the token couldn't be checked
`user` UserInfo | User is the UserInfo associated with the provided token.

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a TokenReview

### HTTP Request

`POST /apis/authentication.k8s.io/v1beta1/tokenreviews`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` TokenReview |

### Response

Code | Description
--- | ---
200 TokenReview | OK
201 TokenReview | Created
202 TokenReview | Accepted

# UserInfo v1beta1 authentication.k8s.io

Group | Version | Kind
--- | --- | ---
`authentication.k8s.io` | `v1beta1` | `UserInfo`

Other api versions of this object exist: v1

UserInfo holds the information about the user needed to implement the user.Info interface.

Appears In:

- TokenReviewStatus authentication/v1beta1

Field | Description
--- | ---
`extra` object | Any additional information provided by the authenticator.
`groups` string array | The names of groups this user is a part of.
`uid` string | A unique value that identifies this user across time. If this user is deleted and another user by the same name is added, they will have different UIDs.
`username` string | The name that uniquely identifies this user among all active users.

# VolumeAttachment v1alpha1 storage.k8s.io

Group | Version | Kind
--- | --- | ---
`storage.k8s.io` | `v1alpha1` | `VolumeAttachment`

Other api versions of this object exist: v1beta1

VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node.

VolumeAttachment objects are non-namespaced.

Appears In:

- VolumeAttachmentList storage/v1alpha1

Field | Description
--- | ---
`apiVersion` string | 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
`kind` string | 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
`metadata` ObjectMeta | Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`spec` VolumeAttachmentSpec | Specification of the desired attach/detach volume behavior. Populated by the Kubernetes system.
`status` VolumeAttachmentStatus | Status of the VolumeAttachment request. Populated by the entity completing the attach or detach operation, i.e. the external-attacher.

### VolumeAttachmentSpec v1alpha1 storage

Appears In:

- VolumeAttachment storage/v1alpha1

Field | Description
--- | ---
`attacher` string | Attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName().
`nodeName` string | The node that the volume should be attached to.
`source` VolumeAttachmentSource | Source represents the volume that should be attached.

### VolumeAttachmentStatus v1alpha1 storage

Appears In:

- VolumeAttachment storage/v1alpha1

Field | Description
--- | ---
`attachError` VolumeError | The last error encountered during attach operation, if any. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
`attached` boolean | Indicates the volume is successfully attached. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
`attachmentMetadata` object | Upon successful attach, this field is populated with any information returned by the attach operation that must be passed into subsequent WaitForAttach or Mount calls. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
`detachError` VolumeError | 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.

### VolumeAttachmentList v1alpha1 storage

Field | Description
--- | ---
`apiVersion` string | 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
`items` VolumeAttachment array | Items is the list of VolumeAttachments
`kind` string | 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
`metadata` ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

## Write Operations

See supported operations below...

## Create

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

create a VolumeAttachment

### HTTP Request

`POST /apis/storage.k8s.io/v1alpha1/volumeattachments`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` VolumeAttachment |

### Response

Code | Description
--- | ---
202 VolumeAttachment | Accepted
200 VolumeAttachment | OK
201 VolumeAttachment | Created

## Patch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

partially update the specified VolumeAttachment

### HTTP Request

`PATCH /apis/storage.k8s.io/v1alpha1/volumeattachments/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the VolumeAttachment

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Patch |

### Response

Code | Description
--- | ---
200 VolumeAttachment | OK

## Replace

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

replace the specified VolumeAttachment

### HTTP Request

`PUT /apis/storage.k8s.io/v1alpha1/volumeattachments/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the VolumeAttachment

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` VolumeAttachment |

### Response

Code | Description
--- | ---
201 VolumeAttachment | Created
200 VolumeAttachment | OK

## Delete

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete a VolumeAttachment

### HTTP Request

`DELETE /apis/storage.k8s.io/v1alpha1/volumeattachments/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the VolumeAttachment

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

Parameter | Description
--- | ---
`body` DeleteOptions |

### Response

Code | Description
--- | ---
200 Status | OK

## Delete Collection

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

delete collection of VolumeAttachment

### HTTP Request

`DELETE /apis/storage.k8s.io/v1alpha1/volumeattachments`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

See supported operations below...

## Read

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

read the specified VolumeAttachment

### HTTP Request

`GET /apis/storage.k8s.io/v1alpha1/volumeattachments/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the VolumeAttachment

### Query Parameters

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.

### Response

Code | Description
--- | ---
200 VolumeAttachment | OK

## List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

list or watch objects of kind VolumeAttachment

### HTTP Request

`GET /apis/storage.k8s.io/v1alpha1/volumeattachments`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 VolumeAttachmentList | OK

## Watch

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch changes to an object of kind VolumeAttachment

### HTTP Request

`GET /apis/storage.k8s.io/v1alpha1/watch/volumeattachments/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the VolumeAttachment

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

## Watch List

> `kubectl` Command

    Coming Soon

> `curl` Command (requires `kubectl proxy` to be running)

    Coming Soon

> Output

    Coming Soon

> Response Body

    Coming Soon

watch individual changes to a list of VolumeAttachment

### HTTP Request

`GET /apis/storage.k8s.io/v1alpha1/watch/volumeattachments`

### Query Parameters

Parameter | Description
--- | ---
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized` | If true, partially initialized resources are included in the response.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 WatchEvent | OK

# VolumeAttachmentSource v1alpha1 storage.k8s.io

Group | Version | Kind
--- | --- | ---
`storage.k8s.io` | `v1alpha1` | `VolumeAttachmentSource`

Other api versions of this object exist: v1beta1

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.

Appears In:

- VolumeAttachmentSpec storage/v1alpha1

Field | Description
--- | ---
`persistentVolumeName` string | Name of the persistent volume to attach.

# VolumeError v1alpha1 storage.k8s.io

Group | Version | Kind
--- | --- | ---
`storage.k8s.io` | `v1alpha1` | `VolumeError`

Other api versions of this object exist: v1beta1

VolumeError captures an error encountered during a volume operation.

Appears In:

- VolumeAttachmentStatus storage/v1alpha1

Field | Description
--- | ---
`message` string | String detailing the error encountered during Attach or Detach operation. This string maybe logged, so it should not contain sensitive information.
`time` Time | Time the error was encountered.